azure-docs-sdk-java/docs-ref-autogen/com.azure.digitaltwins.core...

108 строки
8.6 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.digitaltwins.core.models.ListModelsOptions"
fullName: "com.azure.digitaltwins.core.models.ListModelsOptions"
name: "ListModelsOptions"
nameWithType: "ListModelsOptions"
summary: "The optional parameters for <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClient.listModels*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.digitaltwins.core.DigitalTwinsClient#listModels(ListModelsOptions, Context)\"></xref> and <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient.listModels(com.azure.digitaltwins.core.models.ListModelsOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient#listModels(ListModelsOptions)\"></xref>"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ListModelsOptions**"
constructors:
- uid: "com.azure.digitaltwins.core.models.ListModelsOptions.ListModelsOptions()"
fullName: "com.azure.digitaltwins.core.models.ListModelsOptions.ListModelsOptions()"
name: "ListModelsOptions()"
nameWithType: "ListModelsOptions.ListModelsOptions()"
syntax: "public ListModelsOptions()"
methods:
- uid: "com.azure.digitaltwins.core.models.ListModelsOptions.getDependenciesFor()"
fullName: "com.azure.digitaltwins.core.models.ListModelsOptions.getDependenciesFor()"
name: "getDependenciesFor()"
nameWithType: "ListModelsOptions.getDependenciesFor()"
summary: "Gets the model Ids that will have their dependencies retrieved."
syntax: "public List<String> getDependenciesFor()"
desc: "Gets the model Ids that will have their dependencies retrieved."
returns:
description: "the dependenciesFor value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.digitaltwins.core.models.ListModelsOptions.getIncludeModelDefinition()"
fullName: "com.azure.digitaltwins.core.models.ListModelsOptions.getIncludeModelDefinition()"
name: "getIncludeModelDefinition()"
nameWithType: "ListModelsOptions.getIncludeModelDefinition()"
summary: "Gets whether to include the model definition in the result."
syntax: "public Boolean getIncludeModelDefinition()"
desc: "Gets whether to include the model definition in the result. If false, only the model metadata will be returned."
returns:
description: "the includeModelDefinition value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.digitaltwins.core.models.ListModelsOptions.getMaxItemsPerPage()"
fullName: "com.azure.digitaltwins.core.models.ListModelsOptions.getMaxItemsPerPage()"
name: "getMaxItemsPerPage()"
nameWithType: "ListModelsOptions.getMaxItemsPerPage()"
summary: "Get the max<wbr>Items<wbr>Per<wbr>Page property: The maximum number of items to retrieve per request."
syntax: "public Integer getMaxItemsPerPage()"
desc: "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:
description: "the maxItemsPerPage value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.digitaltwins.core.models.ListModelsOptions.setDependenciesFor(java.util.List<java.lang.String>)"
fullName: "com.azure.digitaltwins.core.models.ListModelsOptions.setDependenciesFor(List<String> dependenciesFor)"
name: "setDependenciesFor(List<String> dependenciesFor)"
nameWithType: "ListModelsOptions.setDependenciesFor(List<String> dependenciesFor)"
summary: "Sets the model Ids that will have their dependencies retrieved."
parameters:
- description: "the dependenciesFor value to set."
name: "dependenciesFor"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public ListModelsOptions setDependenciesFor(List<String> dependenciesFor)"
desc: "Sets the model Ids that will have their dependencies retrieved."
returns:
description: "the ListModelOptions object itself."
type: "<xref href=\"com.azure.digitaltwins.core.models.ListModelsOptions?alt=com.azure.digitaltwins.core.models.ListModelsOptions&text=ListModelsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.digitaltwins.core.models.ListModelsOptions.setIncludeModelDefinition(java.lang.Boolean)"
fullName: "com.azure.digitaltwins.core.models.ListModelsOptions.setIncludeModelDefinition(Boolean includeModelDefinition)"
name: "setIncludeModelDefinition(Boolean includeModelDefinition)"
nameWithType: "ListModelsOptions.setIncludeModelDefinition(Boolean includeModelDefinition)"
summary: "Sets whether to include the model definition in the result."
parameters:
- description: "the includeModelDefinition value to set."
name: "includeModelDefinition"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public ListModelsOptions setIncludeModelDefinition(Boolean includeModelDefinition)"
desc: "Sets whether to include the model definition in the result. If false, only the model metadata will be returned."
returns:
description: "the ListModelOptions object itself."
type: "<xref href=\"com.azure.digitaltwins.core.models.ListModelsOptions?alt=com.azure.digitaltwins.core.models.ListModelsOptions&text=ListModelsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.digitaltwins.core.models.ListModelsOptions.setMaxItemsPerPage(java.lang.Integer)"
fullName: "com.azure.digitaltwins.core.models.ListModelsOptions.setMaxItemsPerPage(Integer maxItemsPerPage)"
name: "setMaxItemsPerPage(Integer maxItemsPerPage)"
nameWithType: "ListModelsOptions.setMaxItemsPerPage(Integer maxItemsPerPage)"
summary: "Set the max<wbr>Items<wbr>Per<wbr>Page property: The maximum number of items to retrieve per request."
parameters:
- description: "the maxItemsPerPage value to set."
name: "maxItemsPerPage"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ListModelsOptions setMaxItemsPerPage(Integer maxItemsPerPage)"
desc: "Set the maxItemsPerPage property: The maximum number of items to retrieve per request. The server may choose to return less than the requested number."
returns:
description: "the ListModelsOptions object itself."
type: "<xref href=\"com.azure.digitaltwins.core.models.ListModelsOptions?alt=com.azure.digitaltwins.core.models.ListModelsOptions&text=ListModelsOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The optional parameters for <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsClient.listModels*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.digitaltwins.core.DigitalTwinsClient#listModels(ListModelsOptions, Context)\"></xref> and <xref uid=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient.listModels(com.azure.digitaltwins.core.models.ListModelsOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.digitaltwins.core.DigitalTwinsAsyncClient#listModels(ListModelsOptions)\"></xref>"
metadata: {}
package: "com.azure.digitaltwins.core.models"
artifact: com.azure:azure-digitaltwins-core:1.3.23