ListModelsOptions Class

Package:

com.azure.digitaltwins.core.models

Maven Artifact:

com.azure:azure-digitaltwins-core:1.5.5

• java.lang.Object
• • com.azure.digitaltwins.core.models.ListModelsOptions

public final class ListModelsOptions

The optional parameters for listModels(ListModelsOptions options, Context context) and listModels(ListModelsOptions options)

Constructor Summary

Constructor	Description
ListModelsOptions()	Creates a new instance of ListModelsOptions.

Method Summary

Modifier and Type	Method and Description
List<String>	getDependenciesFor() Gets the model Ids that will have their dependencies retrieved.
Boolean	getIncludeModelDefinition() Gets whether to include the model definition in the result.
Integer	getMaxItemsPerPage() Get the maxItemsPerPage property: The maximum number of items to retrieve per request.
ListModelsOptions	setDependenciesFor(List<String> dependenciesFor) Sets the model Ids that will have their dependencies retrieved.
ListModelsOptions	setIncludeModelDefinition(Boolean includeModelDefinition) Sets whether to include the model definition in the result.
ListModelsOptions	setMaxItemsPerPage(Integer maxItemsPerPage) Set the maxItemsPerPage property: The maximum number of items to retrieve per request.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ListModelsOptions

public ListModelsOptions()

Creates a new instance of ListModelsOptions.

Method Details

getDependenciesFor

public List<String> getDependenciesFor()

Gets the model Ids that will have their dependencies retrieved.

Returns:

the dependenciesFor value.

getIncludeModelDefinition

public Boolean getIncludeModelDefinition()

Gets whether to include the model definition in the result. If false, only the model metadata will be returned.

Returns:

the includeModelDefinition value.

getMaxItemsPerPage

public Integer getMaxItemsPerPage()

Get the maxItemsPerPage property: The maximum number of items to retrieve per request. The server may choose to return less than the requested number.

Returns:

the maxItemsPerPage value.

setDependenciesFor

public ListModelsOptions setDependenciesFor(List<String> dependenciesFor)

Sets the model Ids that will have their dependencies retrieved.

Parameters:

dependenciesFor - the dependenciesFor value to set.

Returns:

the ListModelOptions object itself.

setIncludeModelDefinition

public ListModelsOptions setIncludeModelDefinition(Boolean includeModelDefinition)

Sets whether to include the model definition in the result. If false, only the model metadata will be returned.

Parameters:

includeModelDefinition - the includeModelDefinition value to set.

Returns:

the ListModelOptions object itself.

setMaxItemsPerPage

public ListModelsOptions setMaxItemsPerPage(Integer maxItemsPerPage)

Set the maxItemsPerPage property: The maximum number of items to retrieve per request. The server may choose to return less than the requested number.

Parameters:

maxItemsPerPage - the maxItemsPerPage value to set.

Returns:

the ListModelsOptions object itself.