Package com.google.cloud.clouddms.v1

Interface CloudSqlSettingsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CloudSqlSettings, CloudSqlSettings.Builder
    public interface CloudSqlSettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getDatabaseVersionValue

        int getDatabaseVersionValue()
         The database engine type and version.
        .google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion database_version = 1;
        Returns:
        The enum numeric value on the wire for databaseVersion.

      • getDatabaseVersion

        CloudSqlSettings.SqlDatabaseVersion getDatabaseVersion()
         The database engine type and version.
        .google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion database_version = 1;
        Returns:
        The databaseVersion.

      • getUserLabelsCount

        int getUserLabelsCount()
         The resource labels for a Cloud SQL instance to use to annotate any related
 underlying resources such as Compute Engine VMs.
 An object containing a list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
        map<string, string> user_labels = 2;

      • containsUserLabels

        boolean containsUserLabels​(String key)
         The resource labels for a Cloud SQL instance to use to annotate any related
 underlying resources such as Compute Engine VMs.
 An object containing a list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
        map<string, string> user_labels = 2;

      • getUserLabelsMap

        Map<String,​String> getUserLabelsMap()
         The resource labels for a Cloud SQL instance to use to annotate any related
 underlying resources such as Compute Engine VMs.
 An object containing a list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
        map<string, string> user_labels = 2;

      • getUserLabelsOrDefault

        String getUserLabelsOrDefault​(String key,
                              String defaultValue)
         The resource labels for a Cloud SQL instance to use to annotate any related
 underlying resources such as Compute Engine VMs.
 An object containing a list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
        map<string, string> user_labels = 2;

      • getUserLabelsOrThrow

        String getUserLabelsOrThrow​(String key)
         The resource labels for a Cloud SQL instance to use to annotate any related
 underlying resources such as Compute Engine VMs.
 An object containing a list of "key": "value" pairs.

 Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
        map<string, string> user_labels = 2;

      • getTier

        String getTier()
         The tier (or machine type) for this instance, for example:
 `db-n1-standard-1` (MySQL instances) or
 `db-custom-1-3840` (PostgreSQL instances).
 For more information, see
 [Cloud SQL Instance
 Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).
        string tier = 3;
        Returns:
        The tier.

      • getTierBytes

        com.google.protobuf.ByteString getTierBytes()
         The tier (or machine type) for this instance, for example:
 `db-n1-standard-1` (MySQL instances) or
 `db-custom-1-3840` (PostgreSQL instances).
 For more information, see
 [Cloud SQL Instance
 Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).
        string tier = 3;
        Returns:
        The bytes for tier.

      • hasStorageAutoResizeLimit

        boolean hasStorageAutoResizeLimit()
         The maximum size to which storage capacity can be automatically increased.
 The default value is 0, which specifies that there is no limit.
        .google.protobuf.Int64Value storage_auto_resize_limit = 4;
        Returns:
        Whether the storageAutoResizeLimit field is set.

      • getStorageAutoResizeLimit

        com.google.protobuf.Int64Value getStorageAutoResizeLimit()
         The maximum size to which storage capacity can be automatically increased.
 The default value is 0, which specifies that there is no limit.
        .google.protobuf.Int64Value storage_auto_resize_limit = 4;
        Returns:
        The storageAutoResizeLimit.

      • getStorageAutoResizeLimitOrBuilder

        com.google.protobuf.Int64ValueOrBuilder getStorageAutoResizeLimitOrBuilder()
         The maximum size to which storage capacity can be automatically increased.
 The default value is 0, which specifies that there is no limit.
        .google.protobuf.Int64Value storage_auto_resize_limit = 4;

      • getActivationPolicyValue

        int getActivationPolicyValue()
         The activation policy specifies when the instance is activated; it is
 applicable only when the instance state is 'RUNNABLE'. Valid values:

 'ALWAYS': The instance is on, and remains so even in
 the absence of connection requests.

 `NEVER`: The instance is off; it is not activated, even if a
 connection request arrives.
        .google.cloud.clouddms.v1.CloudSqlSettings.SqlActivationPolicy activation_policy = 5;
        Returns:
        The enum numeric value on the wire for activationPolicy.

      • getActivationPolicy

        CloudSqlSettings.SqlActivationPolicy getActivationPolicy()
         The activation policy specifies when the instance is activated; it is
 applicable only when the instance state is 'RUNNABLE'. Valid values:

 'ALWAYS': The instance is on, and remains so even in
 the absence of connection requests.

 `NEVER`: The instance is off; it is not activated, even if a
 connection request arrives.
        .google.cloud.clouddms.v1.CloudSqlSettings.SqlActivationPolicy activation_policy = 5;
        Returns:
        The activationPolicy.

      • hasIpConfig

        boolean hasIpConfig()
         The settings for IP Management. This allows to enable or disable the
 instance IP and manage which external networks can connect to the instance.
 The IPv4 address cannot be disabled.
        .google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;
        Returns:
        Whether the ipConfig field is set.

      • getIpConfig

        SqlIpConfig getIpConfig()
         The settings for IP Management. This allows to enable or disable the
 instance IP and manage which external networks can connect to the instance.
 The IPv4 address cannot be disabled.
        .google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;
        Returns:
        The ipConfig.

      • getIpConfigOrBuilder

        SqlIpConfigOrBuilder getIpConfigOrBuilder()
         The settings for IP Management. This allows to enable or disable the
 instance IP and manage which external networks can connect to the instance.
 The IPv4 address cannot be disabled.
        .google.cloud.clouddms.v1.SqlIpConfig ip_config = 6;

      • hasAutoStorageIncrease

        boolean hasAutoStorageIncrease()
         [default: ON] If you enable this setting, Cloud SQL checks your available
 storage every 30 seconds. If the available storage falls below a threshold
 size, Cloud SQL automatically adds additional storage capacity. If the
 available storage repeatedly falls below the threshold size, Cloud SQL
 continues to add storage until it reaches the maximum of 30 TB.
        .google.protobuf.BoolValue auto_storage_increase = 7;
        Returns:
        Whether the autoStorageIncrease field is set.

      • getAutoStorageIncrease

        com.google.protobuf.BoolValue getAutoStorageIncrease()
         [default: ON] If you enable this setting, Cloud SQL checks your available
 storage every 30 seconds. If the available storage falls below a threshold
 size, Cloud SQL automatically adds additional storage capacity. If the
 available storage repeatedly falls below the threshold size, Cloud SQL
 continues to add storage until it reaches the maximum of 30 TB.
        .google.protobuf.BoolValue auto_storage_increase = 7;
        Returns:
        The autoStorageIncrease.

      • getAutoStorageIncreaseOrBuilder

        com.google.protobuf.BoolValueOrBuilder getAutoStorageIncreaseOrBuilder()
         [default: ON] If you enable this setting, Cloud SQL checks your available
 storage every 30 seconds. If the available storage falls below a threshold
 size, Cloud SQL automatically adds additional storage capacity. If the
 available storage repeatedly falls below the threshold size, Cloud SQL
 continues to add storage until it reaches the maximum of 30 TB.
        .google.protobuf.BoolValue auto_storage_increase = 7;

      • getDatabaseFlagsCount

        int getDatabaseFlagsCount()
         The database flags passed to the Cloud SQL instance at startup.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
        map<string, string> database_flags = 8;

      • containsDatabaseFlags

        boolean containsDatabaseFlags​(String key)
         The database flags passed to the Cloud SQL instance at startup.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
        map<string, string> database_flags = 8;

      • getDatabaseFlagsMap

        Map<String,​String> getDatabaseFlagsMap()
         The database flags passed to the Cloud SQL instance at startup.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
        map<string, string> database_flags = 8;

      • getDatabaseFlagsOrDefault

        String getDatabaseFlagsOrDefault​(String key,
                                 String defaultValue)
         The database flags passed to the Cloud SQL instance at startup.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
        map<string, string> database_flags = 8;

      • getDatabaseFlagsOrThrow

        String getDatabaseFlagsOrThrow​(String key)
         The database flags passed to the Cloud SQL instance at startup.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
        map<string, string> database_flags = 8;

      • getDataDiskTypeValue

        int getDataDiskTypeValue()
         The type of storage: `PD_SSD` (default) or `PD_HDD`.
        .google.cloud.clouddms.v1.CloudSqlSettings.SqlDataDiskType data_disk_type = 9;
        Returns:
        The enum numeric value on the wire for dataDiskType.

      • getDataDiskType

        CloudSqlSettings.SqlDataDiskType getDataDiskType()
         The type of storage: `PD_SSD` (default) or `PD_HDD`.
        .google.cloud.clouddms.v1.CloudSqlSettings.SqlDataDiskType data_disk_type = 9;
        Returns:
        The dataDiskType.

      • hasDataDiskSizeGb

        boolean hasDataDiskSizeGb()
         The storage capacity available to the database, in GB.
 The minimum (and default) size is 10GB.
        .google.protobuf.Int64Value data_disk_size_gb = 10;
        Returns:
        Whether the dataDiskSizeGb field is set.

      • getDataDiskSizeGb

        com.google.protobuf.Int64Value getDataDiskSizeGb()
         The storage capacity available to the database, in GB.
 The minimum (and default) size is 10GB.
        .google.protobuf.Int64Value data_disk_size_gb = 10;
        Returns:
        The dataDiskSizeGb.

      • getDataDiskSizeGbOrBuilder

        com.google.protobuf.Int64ValueOrBuilder getDataDiskSizeGbOrBuilder()
         The storage capacity available to the database, in GB.
 The minimum (and default) size is 10GB.
        .google.protobuf.Int64Value data_disk_size_gb = 10;

      • getZone

        String getZone()
         The Google Cloud Platform zone where your Cloud SQL database instance is
 located.
        string zone = 11;
        Returns:
        The zone.

      • getZoneBytes

        com.google.protobuf.ByteString getZoneBytes()
         The Google Cloud Platform zone where your Cloud SQL database instance is
 located.
        string zone = 11;
        Returns:
        The bytes for zone.

      • getSecondaryZone

        String getSecondaryZone()
         Optional. The Google Cloud Platform zone where the failover Cloud SQL
 database instance is located. Used when the Cloud SQL database availability
 type is REGIONAL (i.e. multiple zones / highly available).
        string secondary_zone = 18 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The secondaryZone.

      • getSecondaryZoneBytes

        com.google.protobuf.ByteString getSecondaryZoneBytes()
         Optional. The Google Cloud Platform zone where the failover Cloud SQL
 database instance is located. Used when the Cloud SQL database availability
 type is REGIONAL (i.e. multiple zones / highly available).
        string secondary_zone = 18 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for secondaryZone.

      • getSourceId

        String getSourceId()
         The Database Migration Service source connection profile ID,
 in the format:
 `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`
        string source_id = 12;
        Returns:
        The sourceId.

      • getSourceIdBytes

        com.google.protobuf.ByteString getSourceIdBytes()
         The Database Migration Service source connection profile ID,
 in the format:
 `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`
        string source_id = 12;
        Returns:
        The bytes for sourceId.

      • getRootPassword

        String getRootPassword()
         Input only. Initial root password.
        string root_password = 13 [(.google.api.field_behavior) = INPUT_ONLY];
        Returns:
        The rootPassword.

      • getRootPasswordBytes

        com.google.protobuf.ByteString getRootPasswordBytes()
         Input only. Initial root password.
        string root_password = 13 [(.google.api.field_behavior) = INPUT_ONLY];
        Returns:
        The bytes for rootPassword.

      • getRootPasswordSet

        boolean getRootPasswordSet()
         Output only. Indicates If this connection profile root password is stored.
        bool root_password_set = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The rootPasswordSet.

      • getCollation

        String getCollation()
         The Cloud SQL default instance level collation.
        string collation = 15;
        Returns:
        The collation.

      • getCollationBytes

        com.google.protobuf.ByteString getCollationBytes()
         The Cloud SQL default instance level collation.
        string collation = 15;
        Returns:
        The bytes for collation.

      • getCmekKeyName

        String getCmekKeyName()
         The KMS key name used for the csql instance.
        string cmek_key_name = 16;
        Returns:
        The cmekKeyName.

      • getCmekKeyNameBytes

        com.google.protobuf.ByteString getCmekKeyNameBytes()
         The KMS key name used for the csql instance.
        string cmek_key_name = 16;
        Returns:
        The bytes for cmekKeyName.

      • getAvailabilityTypeValue

        int getAvailabilityTypeValue()
         Optional. Availability type. Potential values:
 *  `ZONAL`: The instance serves data from only one zone. Outages in that
 zone affect data availability.
 *  `REGIONAL`: The instance can serve data from more than one zone in a
 region (it is highly available).
        .google.cloud.clouddms.v1.CloudSqlSettings.SqlAvailabilityType availability_type = 17 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for availabilityType.

      • getAvailabilityType

        CloudSqlSettings.SqlAvailabilityType getAvailabilityType()
         Optional. Availability type. Potential values:
 *  `ZONAL`: The instance serves data from only one zone. Outages in that
 zone affect data availability.
 *  `REGIONAL`: The instance can serve data from more than one zone in a
 region (it is highly available).
        .google.cloud.clouddms.v1.CloudSqlSettings.SqlAvailabilityType availability_type = 17 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The availabilityType.

      • getEditionValue

        int getEditionValue()
         Optional. The edition of the given Cloud SQL instance.
        .google.cloud.clouddms.v1.CloudSqlSettings.Edition edition = 19 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for edition.

      • getEdition

        CloudSqlSettings.Edition getEdition()
         Optional. The edition of the given Cloud SQL instance.
        .google.cloud.clouddms.v1.CloudSqlSettings.Edition edition = 19 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The edition.