azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.r...

233 строки
18 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate"
name: "DatabaseUpdate"
nameWithType: "DatabaseUpdate"
summary: "A partial update to the Redis<wbr>Enterprise database."
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 **DatabaseUpdate**"
constructors:
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.DatabaseUpdate()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.DatabaseUpdate()"
name: "DatabaseUpdate()"
nameWithType: "DatabaseUpdate.DatabaseUpdate()"
summary: "Creates an instance of Database<wbr>Update class."
syntax: "public DatabaseUpdate()"
desc: "Creates an instance of DatabaseUpdate class."
methods:
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.clientProtocol()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.clientProtocol()"
name: "clientProtocol()"
nameWithType: "DatabaseUpdate.clientProtocol()"
summary: "Get the client<wbr>Protocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols."
syntax: "public Protocol clientProtocol()"
desc: "Get the clientProtocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted."
returns:
description: "the clientProtocol value."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.Protocol?alt=com.azure.resourcemanager.redisenterprise.models.Protocol&text=Protocol\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.clusteringPolicy()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.clusteringPolicy()"
name: "clusteringPolicy()"
nameWithType: "DatabaseUpdate.clusteringPolicy()"
summary: "Get the clustering<wbr>Policy property: Clustering policy - default is OSSCluster."
syntax: "public ClusteringPolicy clusteringPolicy()"
desc: "Get the clusteringPolicy property: Clustering policy - default is OSSCluster. Specified at create time."
returns:
description: "the clusteringPolicy value."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.ClusteringPolicy?alt=com.azure.resourcemanager.redisenterprise.models.ClusteringPolicy&text=ClusteringPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.evictionPolicy()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.evictionPolicy()"
name: "evictionPolicy()"
nameWithType: "DatabaseUpdate.evictionPolicy()"
summary: "Get the eviction<wbr>Policy property: Redis eviction policy - default is VolatileLRU."
syntax: "public EvictionPolicy evictionPolicy()"
desc: "Get the evictionPolicy property: Redis eviction policy - default is VolatileLRU."
returns:
description: "the evictionPolicy value."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.EvictionPolicy?alt=com.azure.resourcemanager.redisenterprise.models.EvictionPolicy&text=EvictionPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.geoReplication()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.geoReplication()"
name: "geoReplication()"
nameWithType: "DatabaseUpdate.geoReplication()"
summary: "Get the geo<wbr>Replication property: Optional set of properties to configure geo replication for this database."
syntax: "public DatabasePropertiesGeoReplication geoReplication()"
desc: "Get the geoReplication property: Optional set of properties to configure geo replication for this database."
returns:
description: "the geoReplication value."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabasePropertiesGeoReplication?alt=com.azure.resourcemanager.redisenterprise.models.DatabasePropertiesGeoReplication&text=DatabasePropertiesGeoReplication\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.modules()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.modules()"
name: "modules()"
nameWithType: "DatabaseUpdate.modules()"
summary: "Get the modules property: Optional set of redis modules to enable in this database - modules can only be added at creation time."
syntax: "public List<Module> modules()"
desc: "Get the modules property: Optional set of redis modules to enable in this database - modules can only be added at creation time."
returns:
description: "the modules value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.redisenterprise.models.Module?alt=com.azure.resourcemanager.redisenterprise.models.Module&text=Module\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.persistence()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.persistence()"
name: "persistence()"
nameWithType: "DatabaseUpdate.persistence()"
summary: "Get the persistence property: Persistence settings."
syntax: "public Persistence persistence()"
desc: "Get the persistence property: Persistence settings."
returns:
description: "the persistence value."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.Persistence?alt=com.azure.resourcemanager.redisenterprise.models.Persistence&text=Persistence\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.port()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.port()"
name: "port()"
nameWithType: "DatabaseUpdate.port()"
summary: "Get the port property: TCP port of the database endpoint."
syntax: "public Integer port()"
desc: "Get the port property: TCP port of the database endpoint. Specified at create time. Defaults to an available port."
returns:
description: "the port value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.provisioningState()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.provisioningState()"
name: "provisioningState()"
nameWithType: "DatabaseUpdate.provisioningState()"
summary: "Get the provisioning<wbr>State property: Current provisioning status of the database."
syntax: "public ProvisioningState provisioningState()"
desc: "Get the provisioningState property: Current provisioning status of the database."
returns:
description: "the provisioningState value."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.ProvisioningState?alt=com.azure.resourcemanager.redisenterprise.models.ProvisioningState&text=ProvisioningState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.resourceState()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.resourceState()"
name: "resourceState()"
nameWithType: "DatabaseUpdate.resourceState()"
summary: "Get the resource<wbr>State property: Current resource status of the database."
syntax: "public ResourceState resourceState()"
desc: "Get the resourceState property: Current resource status of the database."
returns:
description: "the resourceState value."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.ResourceState?alt=com.azure.resourcemanager.redisenterprise.models.ResourceState&text=ResourceState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.validate()"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.validate()"
name: "validate()"
nameWithType: "DatabaseUpdate.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withClientProtocol(com.azure.resourcemanager.redisenterprise.models.Protocol)"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withClientProtocol(Protocol clientProtocol)"
name: "withClientProtocol(Protocol clientProtocol)"
nameWithType: "DatabaseUpdate.withClientProtocol(Protocol clientProtocol)"
summary: "Set the client<wbr>Protocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols."
parameters:
- description: "the clientProtocol value to set."
name: "clientProtocol"
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.Protocol?alt=com.azure.resourcemanager.redisenterprise.models.Protocol&text=Protocol\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseUpdate withClientProtocol(Protocol clientProtocol)"
desc: "Set the clientProtocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted."
returns:
description: "the DatabaseUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate?alt=com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate&text=DatabaseUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withClusteringPolicy(com.azure.resourcemanager.redisenterprise.models.ClusteringPolicy)"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withClusteringPolicy(ClusteringPolicy clusteringPolicy)"
name: "withClusteringPolicy(ClusteringPolicy clusteringPolicy)"
nameWithType: "DatabaseUpdate.withClusteringPolicy(ClusteringPolicy clusteringPolicy)"
summary: "Set the clustering<wbr>Policy property: Clustering policy - default is OSSCluster."
parameters:
- description: "the clusteringPolicy value to set."
name: "clusteringPolicy"
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.ClusteringPolicy?alt=com.azure.resourcemanager.redisenterprise.models.ClusteringPolicy&text=ClusteringPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseUpdate withClusteringPolicy(ClusteringPolicy clusteringPolicy)"
desc: "Set the clusteringPolicy property: Clustering policy - default is OSSCluster. Specified at create time."
returns:
description: "the DatabaseUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate?alt=com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate&text=DatabaseUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withEvictionPolicy(com.azure.resourcemanager.redisenterprise.models.EvictionPolicy)"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withEvictionPolicy(EvictionPolicy evictionPolicy)"
name: "withEvictionPolicy(EvictionPolicy evictionPolicy)"
nameWithType: "DatabaseUpdate.withEvictionPolicy(EvictionPolicy evictionPolicy)"
summary: "Set the eviction<wbr>Policy property: Redis eviction policy - default is VolatileLRU."
parameters:
- description: "the evictionPolicy value to set."
name: "evictionPolicy"
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.EvictionPolicy?alt=com.azure.resourcemanager.redisenterprise.models.EvictionPolicy&text=EvictionPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseUpdate withEvictionPolicy(EvictionPolicy evictionPolicy)"
desc: "Set the evictionPolicy property: Redis eviction policy - default is VolatileLRU."
returns:
description: "the DatabaseUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate?alt=com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate&text=DatabaseUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withGeoReplication(com.azure.resourcemanager.redisenterprise.models.DatabasePropertiesGeoReplication)"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withGeoReplication(DatabasePropertiesGeoReplication geoReplication)"
name: "withGeoReplication(DatabasePropertiesGeoReplication geoReplication)"
nameWithType: "DatabaseUpdate.withGeoReplication(DatabasePropertiesGeoReplication geoReplication)"
summary: "Set the geo<wbr>Replication property: Optional set of properties to configure geo replication for this database."
parameters:
- description: "the geoReplication value to set."
name: "geoReplication"
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabasePropertiesGeoReplication?alt=com.azure.resourcemanager.redisenterprise.models.DatabasePropertiesGeoReplication&text=DatabasePropertiesGeoReplication\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseUpdate withGeoReplication(DatabasePropertiesGeoReplication geoReplication)"
desc: "Set the geoReplication property: Optional set of properties to configure geo replication for this database."
returns:
description: "the DatabaseUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate?alt=com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate&text=DatabaseUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withModules(java.util.List<com.azure.resourcemanager.redisenterprise.models.Module>)"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withModules(List<Module> modules)"
name: "withModules(List<Module> modules)"
nameWithType: "DatabaseUpdate.withModules(List<Module> modules)"
summary: "Set the modules property: Optional set of redis modules to enable in this database - modules can only be added at creation time."
parameters:
- description: "the modules value to set."
name: "modules"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.redisenterprise.models.Module?alt=com.azure.resourcemanager.redisenterprise.models.Module&text=Module\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public DatabaseUpdate withModules(List<Module> modules)"
desc: "Set the modules property: Optional set of redis modules to enable in this database - modules can only be added at creation time."
returns:
description: "the DatabaseUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate?alt=com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate&text=DatabaseUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withPersistence(com.azure.resourcemanager.redisenterprise.models.Persistence)"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withPersistence(Persistence persistence)"
name: "withPersistence(Persistence persistence)"
nameWithType: "DatabaseUpdate.withPersistence(Persistence persistence)"
summary: "Set the persistence property: Persistence settings."
parameters:
- description: "the persistence value to set."
name: "persistence"
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.Persistence?alt=com.azure.resourcemanager.redisenterprise.models.Persistence&text=Persistence\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DatabaseUpdate withPersistence(Persistence persistence)"
desc: "Set the persistence property: Persistence settings."
returns:
description: "the DatabaseUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate?alt=com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate&text=DatabaseUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withPort(java.lang.Integer)"
fullName: "com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate.withPort(Integer port)"
name: "withPort(Integer port)"
nameWithType: "DatabaseUpdate.withPort(Integer port)"
summary: "Set the port property: TCP port of the database endpoint."
parameters:
- description: "the port value to set."
name: "port"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public DatabaseUpdate withPort(Integer port)"
desc: "Set the port property: TCP port of the database endpoint. Specified at create time. Defaults to an available port."
returns:
description: "the DatabaseUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate?alt=com.azure.resourcemanager.redisenterprise.models.DatabaseUpdate&text=DatabaseUpdate\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A partial update to the RedisEnterprise database."
metadata: {}
package: "com.azure.resourcemanager.redisenterprise.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-redisenterprise:2.0.0