Class AlloyDbSettings.PrimaryInstanceSettings.Builder (2.82.0)

public static final class AlloyDbSettings.PrimaryInstanceSettings.Builder extends GeneratedMessage.Builder<AlloyDbSettings.PrimaryInstanceSettings.Builder> implements AlloyDbSettings.PrimaryInstanceSettingsOrBuilder

Settings for the cluster's primary instance

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public AlloyDbSettings.PrimaryInstanceSettings build()
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings

buildPartial()

public AlloyDbSettings.PrimaryInstanceSettings buildPartial()
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings

clear()

public AlloyDbSettings.PrimaryInstanceSettings.Builder clear()
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder
Overrides

clearDatabaseFlags()

public AlloyDbSettings.PrimaryInstanceSettings.Builder clearDatabaseFlags()
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

clearId()

public AlloyDbSettings.PrimaryInstanceSettings.Builder clearId()

Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

This builder for chaining.

clearLabels()

public AlloyDbSettings.PrimaryInstanceSettings.Builder clearLabels()
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

clearMachineConfig()

public AlloyDbSettings.PrimaryInstanceSettings.Builder clearMachineConfig()

Configuration for the machines that host the underlying database engine.

.google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig machine_config = 2;

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

clearPrivateIp()

public AlloyDbSettings.PrimaryInstanceSettings.Builder clearPrivateIp()

Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.

string private_ip = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

This builder for chaining.

containsDatabaseFlags(String key)

public boolean containsDatabaseFlags(String key)

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

map<string, string> database_flags = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDatabaseFlags() (deprecated)

public Map<String,String> getDatabaseFlags()
Returns
Type Description
Map<String,String>

getDatabaseFlagsCount()

public int getDatabaseFlagsCount()

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

map<string, string> database_flags = 6;

Returns
Type Description
int

getDatabaseFlagsMap()

public Map<String,String> getDatabaseFlagsMap()

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

map<string, string> database_flags = 6;

Returns
Type Description
Map<String,String>

getDatabaseFlagsOrDefault(String key, String defaultValue)

public String getDatabaseFlagsOrDefault(String key, String defaultValue)

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

map<string, string> database_flags = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getDatabaseFlagsOrThrow(String key)

public String getDatabaseFlagsOrThrow(String key)

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

map<string, string> database_flags = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public AlloyDbSettings.PrimaryInstanceSettings getDefaultInstanceForType()
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getId()

public String getId()

Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for id.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

map<string, string> labels = 7;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

map<string, string> labels = 7;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

map<string, string> labels = 7;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
String

getMachineConfig()

public AlloyDbSettings.PrimaryInstanceSettings.MachineConfig getMachineConfig()

Configuration for the machines that host the underlying database engine.

.google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig machine_config = 2;

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.MachineConfig

The machineConfig.

getMachineConfigBuilder()

public AlloyDbSettings.PrimaryInstanceSettings.MachineConfig.Builder getMachineConfigBuilder()

Configuration for the machines that host the underlying database engine.

.google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig machine_config = 2;

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.MachineConfig.Builder

getMachineConfigOrBuilder()

public AlloyDbSettings.PrimaryInstanceSettings.MachineConfigOrBuilder getMachineConfigOrBuilder()

Configuration for the machines that host the underlying database engine.

.google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig machine_config = 2;

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.MachineConfigOrBuilder

getMutableDatabaseFlags() (deprecated)

public Map<String,String> getMutableDatabaseFlags()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getPrivateIp()

public String getPrivateIp()

Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.

string private_ip = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The privateIp.

getPrivateIpBytes()

public ByteString getPrivateIpBytes()

Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.

string private_ip = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for privateIp.

hasMachineConfig()

public boolean hasMachineConfig()

Configuration for the machines that host the underlying database engine.

.google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig machine_config = 2;

Returns
Type Description
boolean

Whether the machineConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AlloyDbSettings.PrimaryInstanceSettings other)

public AlloyDbSettings.PrimaryInstanceSettings.Builder mergeFrom(AlloyDbSettings.PrimaryInstanceSettings other)
Parameter
Name Description
other AlloyDbSettings.PrimaryInstanceSettings
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AlloyDbSettings.PrimaryInstanceSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AlloyDbSettings.PrimaryInstanceSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder
Overrides

mergeMachineConfig(AlloyDbSettings.PrimaryInstanceSettings.MachineConfig value)

public AlloyDbSettings.PrimaryInstanceSettings.Builder mergeMachineConfig(AlloyDbSettings.PrimaryInstanceSettings.MachineConfig value)

Configuration for the machines that host the underlying database engine.

.google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig machine_config = 2;

Parameter
Name Description
value AlloyDbSettings.PrimaryInstanceSettings.MachineConfig
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

putAllDatabaseFlags(Map<String,String> values)

public AlloyDbSettings.PrimaryInstanceSettings.Builder putAllDatabaseFlags(Map<String,String> values)

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

map<string, string> database_flags = 6;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

putAllLabels(Map<String,String> values)

public AlloyDbSettings.PrimaryInstanceSettings.Builder putAllLabels(Map<String,String> values)

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

map<string, string> labels = 7;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

putDatabaseFlags(String key, String value)

public AlloyDbSettings.PrimaryInstanceSettings.Builder putDatabaseFlags(String key, String value)

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

map<string, string> database_flags = 6;

Parameters
Name Description
key String
value String
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

putLabels(String key, String value)

public AlloyDbSettings.PrimaryInstanceSettings.Builder putLabels(String key, String value)

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

map<string, string> labels = 7;

Parameters
Name Description
key String
value String
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

removeDatabaseFlags(String key)

public AlloyDbSettings.PrimaryInstanceSettings.Builder removeDatabaseFlags(String key)

Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.

map<string, string> database_flags = 6;

Parameter
Name Description
key String
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

removeLabels(String key)

public AlloyDbSettings.PrimaryInstanceSettings.Builder removeLabels(String key)

Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

setId(String value)

public AlloyDbSettings.PrimaryInstanceSettings.Builder setId(String value)

Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The id to set.

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

This builder for chaining.

setIdBytes(ByteString value)

public AlloyDbSettings.PrimaryInstanceSettings.Builder setIdBytes(ByteString value)

Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

This builder for chaining.

setMachineConfig(AlloyDbSettings.PrimaryInstanceSettings.MachineConfig value)

public AlloyDbSettings.PrimaryInstanceSettings.Builder setMachineConfig(AlloyDbSettings.PrimaryInstanceSettings.MachineConfig value)

Configuration for the machines that host the underlying database engine.

.google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig machine_config = 2;

Parameter
Name Description
value AlloyDbSettings.PrimaryInstanceSettings.MachineConfig
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

setMachineConfig(AlloyDbSettings.PrimaryInstanceSettings.MachineConfig.Builder builderForValue)

public AlloyDbSettings.PrimaryInstanceSettings.Builder setMachineConfig(AlloyDbSettings.PrimaryInstanceSettings.MachineConfig.Builder builderForValue)

Configuration for the machines that host the underlying database engine.

.google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig machine_config = 2;

Parameter
Name Description
builderForValue AlloyDbSettings.PrimaryInstanceSettings.MachineConfig.Builder
Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

setPrivateIp(String value)

public AlloyDbSettings.PrimaryInstanceSettings.Builder setPrivateIp(String value)

Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.

string private_ip = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The privateIp to set.

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

This builder for chaining.

setPrivateIpBytes(ByteString value)

public AlloyDbSettings.PrimaryInstanceSettings.Builder setPrivateIpBytes(ByteString value)

Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.

string private_ip = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for privateIp to set.

Returns
Type Description
AlloyDbSettings.PrimaryInstanceSettings.Builder

This builder for chaining.