Class AlloyDbSettings (2.18.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 2.18.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  AlloyDbSettings   extends   GeneratedMessageV3   implements   AlloyDbSettingsOrBuilder  
   Settings for creating an AlloyDB cluster.
 Protobuf type google.cloud.clouddms.v1.AlloyDbSettings
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  ENCRYPTION_CONFIG_FIELD_NUMBER 
  
    
public   static   final   int   ENCRYPTION_CONFIG_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  INITIAL_USER_FIELD_NUMBER 
  
    
public   static   final   int   INITIAL_USER_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  LABELS_FIELD_NUMBER 
  
    
public   static   final   int   LABELS_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  PRIMARY_INSTANCE_SETTINGS_FIELD_NUMBER 
  
    
public   static   final   int   PRIMARY_INSTANCE_SETTINGS_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  VPC_NETWORK_FIELD_NUMBER 
  
    
public   static   final   int   VPC_NETWORK_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   AlloyDbSettings   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   AlloyDbSettings . Builder   newBuilder ()  
  
  newBuilder(AlloyDbSettings prototype) 
  
    
public   static   AlloyDbSettings . Builder   newBuilder ( AlloyDbSettings   prototype )  
  
  
  
    
public   static   AlloyDbSettings   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   AlloyDbSettings   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   AlloyDbSettings   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   AlloyDbSettings   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   AlloyDbSettings   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   AlloyDbSettings   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   AlloyDbSettings   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   AlloyDbSettings   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   AlloyDbSettings   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   AlloyDbSettings   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   AlloyDbSettings   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   AlloyDbSettings   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<AlloyDbSettings>   parser ()  
  
  Methods
   
  containsLabels(String key) 
  
    
public   boolean   containsLabels ( String   key )  
   Labels for the AlloyDB cluster created by DMS. An object containing a list
 of 'key', 'value' pairs.
 map<string, string> labels = 3;
    
      
        Parameter  
      
        Name Description  
      
        keyString  
     
  
  
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getDefaultInstanceForType() 
  
    
public   AlloyDbSettings   getDefaultInstanceForType ()  
  
  getEncryptionConfig() 
  
    
public   AlloyDbSettings . EncryptionConfig   getEncryptionConfig ()  
   Optional. The encryption config can be specified to encrypt the data disks
 and other persistent data resources of a cluster with a
 customer-managed encryption key (CMEK). When this field is not
 specified, the cluster will then use default encryption scheme to
 protect the user data.
 
 .google.cloud.clouddms.v1.AlloyDbSettings.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
 
getEncryptionConfigOrBuilder() 
  
    
public   AlloyDbSettings . EncryptionConfigOrBuilder   getEncryptionConfigOrBuilder ()  
   Optional. The encryption config can be specified to encrypt the data disks
 and other persistent data resources of a cluster with a
 customer-managed encryption key (CMEK). When this field is not
 specified, the cluster will then use default encryption scheme to
 protect the user data.
 
 .google.cloud.clouddms.v1.AlloyDbSettings.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
 
getInitialUser() 
  
    
public   AlloyDbSettings . UserPassword   getInitialUser ()  
   Required. Input only. Initial user to setup during cluster creation.
 Required.
 
 .google.cloud.clouddms.v1.AlloyDbSettings.UserPassword initial_user = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
 
getInitialUserOrBuilder() 
  
    
public   AlloyDbSettings . UserPasswordOrBuilder   getInitialUserOrBuilder ()  
   Required. Input only. Initial user to setup during cluster creation.
 Required.
 
 .google.cloud.clouddms.v1.AlloyDbSettings.UserPassword initial_user = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
 
getLabels() 
  
    
public   Map<String , String >  getLabels ()  
  
  
  getLabelsCount() 
  
    
public   int   getLabelsCount ()  
   Labels for the AlloyDB cluster created by DMS. An object containing a list
 of 'key', 'value' pairs.
 map<string, string> labels = 3;
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  getLabelsMap() 
  
    
public   Map<String , String >  getLabelsMap ()  
   Labels for the AlloyDB cluster created by DMS. An object containing a list
 of 'key', 'value' pairs.
 map<string, string> labels = 3;
getLabelsOrDefault(String key, String defaultValue) 
  
    
public   String   getLabelsOrDefault ( String   key ,   String   defaultValue )  
   Labels for the AlloyDB cluster created by DMS. An object containing a list
 of 'key', 'value' pairs.
 map<string, string> labels = 3;
    
      
        Returns  
      
        Type Description  
      
        String  
     
  
  getLabelsOrThrow(String key) 
  
    
public   String   getLabelsOrThrow ( String   key )  
   Labels for the AlloyDB cluster created by DMS. An object containing a list
 of 'key', 'value' pairs.
 map<string, string> labels = 3;
    
      
        Parameter  
      
        Name Description  
      
        keyString  
     
  
  
    
      
        Returns  
      
        Type Description  
      
        String  
     
  
  getParserForType() 
  
    
public   Parser<AlloyDbSettings>   getParserForType ()  
  
  Overrides 
  
  getPrimaryInstanceSettings() 
  
    
public   AlloyDbSettings . PrimaryInstanceSettings   getPrimaryInstanceSettings ()  
  
 .google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings primary_instance_settings = 4;
 
getPrimaryInstanceSettingsOrBuilder() 
  
    
public   AlloyDbSettings . PrimaryInstanceSettingsOrBuilder   getPrimaryInstanceSettingsOrBuilder ()  
  
 .google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings primary_instance_settings = 4;
 
getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  getVpcNetwork() 
  
    
public   String   getVpcNetwork ()  
   Required. The resource link for the VPC network in which cluster resources
 are created and from which they are accessible via Private IP. The network
 must belong to the same project as the cluster. It is specified in the
 form: "projects/{project_number}/global/networks/{network_id}". This is
 required to create a cluster.
 string vpc_network = 2 [(.google.api.field_behavior) = REQUIRED];
    
      
        Returns  
      
        Type Description  
      
        String The vpcNetwork.
 
     
  
  getVpcNetworkBytes() 
  
    
public   ByteString   getVpcNetworkBytes ()  
   Required. The resource link for the VPC network in which cluster resources
 are created and from which they are accessible via Private IP. The network
 must belong to the same project as the cluster. It is specified in the
 form: "projects/{project_number}/global/networks/{network_id}". This is
 required to create a cluster.
 string vpc_network = 2 [(.google.api.field_behavior) = REQUIRED];
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for vpcNetwork.
 
     
  
  hasEncryptionConfig() 
  
    
public   boolean   hasEncryptionConfig ()  
   Optional. The encryption config can be specified to encrypt the data disks
 and other persistent data resources of a cluster with a
 customer-managed encryption key (CMEK). When this field is not
 specified, the cluster will then use default encryption scheme to
 protect the user data.
 
 .google.cloud.clouddms.v1.AlloyDbSettings.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the encryptionConfig field is set.
 
     
  
  hasInitialUser() 
  
    
public   boolean   hasInitialUser ()  
   Required. Input only. Initial user to setup during cluster creation.
 Required.
 
 .google.cloud.clouddms.v1.AlloyDbSettings.UserPassword initial_user = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the initialUser field is set.
 
     
  
  hasPrimaryInstanceSettings() 
  
    
public   boolean   hasPrimaryInstanceSettings ()  
  
 .google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings primary_instance_settings = 4;
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the primaryInstanceSettings field is set.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  internalGetMapField(int number) 
  
    
protected   MapField   internalGetMapField ( int   number )  
  
    
      
        Parameter  
      
        Name Description  
      
        numberint  
     
  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   AlloyDbSettings . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   AlloyDbSettings . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   AlloyDbSettings . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]