All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.sqladmin.model.Settings.html Maven / Gradle / Ivy

There is a newer version: v1-rev20241108-2.0.0
Show newest version






Settings (Cloud SQL Admin API v1-rev20240925-2.0.0)












com.google.api.services.sqladmin.model

Class Settings

    • Constructor Detail

      • Settings

        public Settings()
    • Method Detail

      • getActivationPolicy

        public String 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.
        Returns:
        value or null for none
      • setActivationPolicy

        public Settings setActivationPolicy(String activationPolicy)
        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.
        Parameters:
        activationPolicy - activationPolicy or null for none
      • getActiveDirectoryConfig

        public SqlActiveDirectoryConfig getActiveDirectoryConfig()
        Active Directory configuration, relevant only for Cloud SQL for SQL Server.
        Returns:
        value or null for none
      • setActiveDirectoryConfig

        public Settings setActiveDirectoryConfig(SqlActiveDirectoryConfig activeDirectoryConfig)
        Active Directory configuration, relevant only for Cloud SQL for SQL Server.
        Parameters:
        activeDirectoryConfig - activeDirectoryConfig or null for none
      • getAdvancedMachineFeatures

        public AdvancedMachineFeatures getAdvancedMachineFeatures()
        Specifies advanced machine configuration for the instances relevant only for SQL Server.
        Returns:
        value or null for none
      • setAdvancedMachineFeatures

        public Settings setAdvancedMachineFeatures(AdvancedMachineFeatures advancedMachineFeatures)
        Specifies advanced machine configuration for the instances relevant only for SQL Server.
        Parameters:
        advancedMachineFeatures - advancedMachineFeatures or null for none
      • getAuthorizedGaeApplications

        public List<String> getAuthorizedGaeApplications()
        The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
        Returns:
        value or null for none
      • setAuthorizedGaeApplications

        public Settings setAuthorizedGaeApplications(List<String> authorizedGaeApplications)
        The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
        Parameters:
        authorizedGaeApplications - authorizedGaeApplications or null for none
      • getAvailabilityType

        public String getAvailabilityType()
        Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see [Overview of the High Availability Configuration](https://cloud.google.com/sql/docs/mysql/high- availability).
        Returns:
        value or null for none
      • setAvailabilityType

        public Settings setAvailabilityType(String availabilityType)
        Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see [Overview of the High Availability Configuration](https://cloud.google.com/sql/docs/mysql/high- availability).
        Parameters:
        availabilityType - availabilityType or null for none
      • getBackupConfiguration

        public BackupConfiguration getBackupConfiguration()
        The daily backup configuration for the instance.
        Returns:
        value or null for none
      • setBackupConfiguration

        public Settings setBackupConfiguration(BackupConfiguration backupConfiguration)
        The daily backup configuration for the instance.
        Parameters:
        backupConfiguration - backupConfiguration or null for none
      • getCollation

        public String getCollation()
        The name of server Instance collation.
        Returns:
        value or null for none
      • setCollation

        public Settings setCollation(String collation)
        The name of server Instance collation.
        Parameters:
        collation - collation or null for none
      • getConnectorEnforcement

        public String getConnectorEnforcement()
        Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
        Returns:
        value or null for none
      • setConnectorEnforcement

        public Settings setConnectorEnforcement(String connectorEnforcement)
        Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
        Parameters:
        connectorEnforcement - connectorEnforcement or null for none
      • getCrashSafeReplicationEnabled

        public Boolean getCrashSafeReplicationEnabled()
        Configuration specific to read replica instances. Indicates whether database flags for crash- safe replication are enabled. This property was only applicable to First Generation instances.
        Returns:
        value or null for none
      • setCrashSafeReplicationEnabled

        public Settings setCrashSafeReplicationEnabled(Boolean crashSafeReplicationEnabled)
        Configuration specific to read replica instances. Indicates whether database flags for crash- safe replication are enabled. This property was only applicable to First Generation instances.
        Parameters:
        crashSafeReplicationEnabled - crashSafeReplicationEnabled or null for none
      • getDataCacheConfig

        public DataCacheConfig getDataCacheConfig()
        Configuration for data cache.
        Returns:
        value or null for none
      • setDataCacheConfig

        public Settings setDataCacheConfig(DataCacheConfig dataCacheConfig)
        Configuration for data cache.
        Parameters:
        dataCacheConfig - dataCacheConfig or null for none
      • getDataDiskSizeGb

        public Long getDataDiskSizeGb()
        The size of data disk, in GB. The data disk size minimum is 10GB.
        Returns:
        value or null for none
      • setDataDiskSizeGb

        public Settings setDataDiskSizeGb(Long dataDiskSizeGb)
        The size of data disk, in GB. The data disk size minimum is 10GB.
        Parameters:
        dataDiskSizeGb - dataDiskSizeGb or null for none
      • getDataDiskType

        public String getDataDiskType()
        The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances.
        Returns:
        value or null for none
      • setDataDiskType

        public Settings setDataDiskType(String dataDiskType)
        The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances.
        Parameters:
        dataDiskType - dataDiskType or null for none
      • getDatabaseFlags

        public List<DatabaseFlags> getDatabaseFlags()
        The database flags passed to the instance at startup.
        Returns:
        value or null for none
      • setDatabaseFlags

        public Settings setDatabaseFlags(List<DatabaseFlags> databaseFlags)
        The database flags passed to the instance at startup.
        Parameters:
        databaseFlags - databaseFlags or null for none
      • getDatabaseReplicationEnabled

        public Boolean getDatabaseReplicationEnabled()
        Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
        Returns:
        value or null for none
      • setDatabaseReplicationEnabled

        public Settings setDatabaseReplicationEnabled(Boolean databaseReplicationEnabled)
        Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
        Parameters:
        databaseReplicationEnabled - databaseReplicationEnabled or null for none
      • getDeletionProtectionEnabled

        public Boolean getDeletionProtectionEnabled()
        Configuration to protect against accidental instance deletion.
        Returns:
        value or null for none
      • setDeletionProtectionEnabled

        public Settings setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
        Configuration to protect against accidental instance deletion.
        Parameters:
        deletionProtectionEnabled - deletionProtectionEnabled or null for none
      • getDenyMaintenancePeriods

        public List<DenyMaintenancePeriod> getDenyMaintenancePeriods()
        Deny maintenance periods
        Returns:
        value or null for none
      • setDenyMaintenancePeriods

        public Settings setDenyMaintenancePeriods(List<DenyMaintenancePeriod> denyMaintenancePeriods)
        Deny maintenance periods
        Parameters:
        denyMaintenancePeriods - denyMaintenancePeriods or null for none
      • getEdition

        public String getEdition()
        Optional. The edition of the instance.
        Returns:
        value or null for none
      • setEdition

        public Settings setEdition(String edition)
        Optional. The edition of the instance.
        Parameters:
        edition - edition or null for none
      • getEnableDataplexIntegration

        public Boolean getEnableDataplexIntegration()
        Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated.
        Returns:
        value or null for none
      • setEnableDataplexIntegration

        public Settings setEnableDataplexIntegration(Boolean enableDataplexIntegration)
        Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated.
        Parameters:
        enableDataplexIntegration - enableDataplexIntegration or null for none
      • getEnableGoogleMlIntegration

        public Boolean getEnableGoogleMlIntegration()
        Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.
        Returns:
        value or null for none
      • setEnableGoogleMlIntegration

        public Settings setEnableGoogleMlIntegration(Boolean enableGoogleMlIntegration)
        Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.
        Parameters:
        enableGoogleMlIntegration - enableGoogleMlIntegration or null for none
      • getInsightsConfig

        public InsightsConfig getInsightsConfig()
        Insights configuration, for now relevant only for Postgres.
        Returns:
        value or null for none
      • setInsightsConfig

        public Settings setInsightsConfig(InsightsConfig insightsConfig)
        Insights configuration, for now relevant only for Postgres.
        Parameters:
        insightsConfig - insightsConfig or null for none
      • getIpConfiguration

        public IpConfiguration getIpConfiguration()
        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 for Second Generation instances.
        Returns:
        value or null for none
      • setIpConfiguration

        public Settings setIpConfiguration(IpConfiguration ipConfiguration)
        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 for Second Generation instances.
        Parameters:
        ipConfiguration - ipConfiguration or null for none
      • getKind

        public String getKind()
        This is always `sql#settings`.
        Returns:
        value or null for none
      • setKind

        public Settings setKind(String kind)
        This is always `sql#settings`.
        Parameters:
        kind - kind or null for none
      • getLocationPreference

        public LocationPreference getLocationPreference()
        The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
        Returns:
        value or null for none
      • setLocationPreference

        public Settings setLocationPreference(LocationPreference locationPreference)
        The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
        Parameters:
        locationPreference - locationPreference or null for none
      • getMaintenanceWindow

        public MaintenanceWindow getMaintenanceWindow()
        The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
        Returns:
        value or null for none
      • setMaintenanceWindow

        public Settings setMaintenanceWindow(MaintenanceWindow maintenanceWindow)
        The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
        Parameters:
        maintenanceWindow - maintenanceWindow or null for none
      • getPasswordValidationPolicy

        public PasswordValidationPolicy getPasswordValidationPolicy()
        The local user password validation policy of the instance.
        Returns:
        value or null for none
      • setPasswordValidationPolicy

        public Settings setPasswordValidationPolicy(PasswordValidationPolicy passwordValidationPolicy)
        The local user password validation policy of the instance.
        Parameters:
        passwordValidationPolicy - passwordValidationPolicy or null for none
      • getPricingPlan

        public String getPricingPlan()
        The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
        Returns:
        value or null for none
      • setPricingPlan

        public Settings setPricingPlan(String pricingPlan)
        The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
        Parameters:
        pricingPlan - pricingPlan or null for none
      • getReplicationType

        public String getReplicationType()
        The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
        Returns:
        value or null for none
      • setReplicationType

        public Settings setReplicationType(String replicationType)
        The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
        Parameters:
        replicationType - replicationType or null for none
      • getSettingsVersion

        public Long getSettingsVersion()
        The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
        Returns:
        value or null for none
      • setSettingsVersion

        public Settings setSettingsVersion(Long settingsVersion)
        The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
        Parameters:
        settingsVersion - settingsVersion or null for none
      • getSqlServerAuditConfig

        public SqlServerAuditConfig getSqlServerAuditConfig()
        SQL Server specific audit configuration.
        Returns:
        value or null for none
      • setSqlServerAuditConfig

        public Settings setSqlServerAuditConfig(SqlServerAuditConfig sqlServerAuditConfig)
        SQL Server specific audit configuration.
        Parameters:
        sqlServerAuditConfig - sqlServerAuditConfig or null for none
      • getStorageAutoResize

        public Boolean getStorageAutoResize()
        Configuration to increase storage size automatically. The default value is true.
        Returns:
        value or null for none
      • setStorageAutoResize

        public Settings setStorageAutoResize(Boolean storageAutoResize)
        Configuration to increase storage size automatically. The default value is true.
        Parameters:
        storageAutoResize - storageAutoResize or null for none
      • getStorageAutoResizeLimit

        public Long getStorageAutoResizeLimit()
        The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
        Returns:
        value or null for none
      • setStorageAutoResizeLimit

        public Settings setStorageAutoResizeLimit(Long storageAutoResizeLimit)
        The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
        Parameters:
        storageAutoResizeLimit - storageAutoResizeLimit or null for none
      • getTier

        public String getTier()
        The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance.
        Returns:
        value or null for none
      • setTier

        public Settings setTier(String tier)
        The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance.
        Parameters:
        tier - tier or null for none
      • getTimeZone

        public String getTimeZone()
        Server timezone, relevant only for Cloud SQL for SQL Server.
        Returns:
        value or null for none
      • setTimeZone

        public Settings setTimeZone(String timeZone)
        Server timezone, relevant only for Cloud SQL for SQL Server.
        Parameters:
        timeZone - timeZone or null for none
      • getUserLabels

        public Map<String,String> getUserLabels()
        User-provided labels, represented as a dictionary where each label is a single key value pair.
        Returns:
        value or null for none
      • setUserLabels

        public Settings setUserLabels(Map<String,String> userLabels)
        User-provided labels, represented as a dictionary where each label is a single key value pair.
        Parameters:
        userLabels - userLabels or null for none
      • set

        public Settings set(String fieldName,
                            Object value)
        Overrides:
        set in class com.google.api.client.json.GenericJson
      • clone

        public Settings clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson

Copyright © 2011–2024 Google. All rights reserved.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy