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

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

The newest version!






DatabaseInstance (Cloud SQL Admin API v1-rev20241108-2.0.0)












com.google.api.services.sqladmin.model

Class DatabaseInstance

    • Constructor Detail

      • DatabaseInstance

        public DatabaseInstance()
    • Method Detail

      • getAvailableMaintenanceVersions

        public List<String> getAvailableMaintenanceVersions()
        Output only. List all maintenance versions applicable on the instance
        Returns:
        value or null for none
      • setAvailableMaintenanceVersions

        public DatabaseInstance setAvailableMaintenanceVersions(List<String> availableMaintenanceVersions)
        Output only. List all maintenance versions applicable on the instance
        Parameters:
        availableMaintenanceVersions - availableMaintenanceVersions or null for none
      • getBackendType

        public String getBackendType()
        The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type.
        Returns:
        value or null for none
      • setBackendType

        public DatabaseInstance setBackendType(String backendType)
        The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type.
        Parameters:
        backendType - backendType or null for none
      • getConnectionName

        public String getConnectionName()
        Connection name of the Cloud SQL instance used in connection strings.
        Returns:
        value or null for none
      • setConnectionName

        public DatabaseInstance setConnectionName(String connectionName)
        Connection name of the Cloud SQL instance used in connection strings.
        Parameters:
        connectionName - connectionName or null for none
      • getCreateTime

        public String getCreateTime()
        Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
        Returns:
        value or null for none
      • setCreateTime

        public DatabaseInstance setCreateTime(String createTime)
        Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
        Parameters:
        createTime - createTime or null for none
      • getCurrentDiskSize

        public Long getCurrentDiskSize()
        The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql- announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details.
        Returns:
        value or null for none
      • setCurrentDiskSize

        public DatabaseInstance setCurrentDiskSize(Long currentDiskSize)
        The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql- announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details.
        Parameters:
        currentDiskSize - currentDiskSize or null for none
      • getDatabaseInstalledVersion

        public String getDatabaseInstalledVersion()
        Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`.
        Returns:
        value or null for none
      • setDatabaseInstalledVersion

        public DatabaseInstance setDatabaseInstalledVersion(String databaseInstalledVersion)
        Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`.
        Parameters:
        databaseInstalledVersion - databaseInstalledVersion or null for none
      • getDatabaseVersion

        public String getDatabaseVersion()
        The database engine type and version. The `databaseVersion` field cannot be changed after instance creation.
        Returns:
        value or null for none
      • setDatabaseVersion

        public DatabaseInstance setDatabaseVersion(String databaseVersion)
        The database engine type and version. The `databaseVersion` field cannot be changed after instance creation.
        Parameters:
        databaseVersion - databaseVersion or null for none
      • getDiskEncryptionConfiguration

        public DiskEncryptionConfiguration getDiskEncryptionConfiguration()
        Disk encryption configuration specific to an instance.
        Returns:
        value or null for none
      • setDiskEncryptionConfiguration

        public DatabaseInstance setDiskEncryptionConfiguration(DiskEncryptionConfiguration diskEncryptionConfiguration)
        Disk encryption configuration specific to an instance.
        Parameters:
        diskEncryptionConfiguration - diskEncryptionConfiguration or null for none
      • getDiskEncryptionStatus

        public DiskEncryptionStatus getDiskEncryptionStatus()
        Disk encryption status specific to an instance.
        Returns:
        value or null for none
      • setDiskEncryptionStatus

        public DatabaseInstance setDiskEncryptionStatus(DiskEncryptionStatus diskEncryptionStatus)
        Disk encryption status specific to an instance.
        Parameters:
        diskEncryptionStatus - diskEncryptionStatus or null for none
      • getDnsName

        public String getDnsName()
        Output only. The dns name of the instance.
        Returns:
        value or null for none
      • setDnsName

        public DatabaseInstance setDnsName(String dnsName)
        Output only. The dns name of the instance.
        Parameters:
        dnsName - dnsName or null for none
      • getEtag

        public String getEtag()
        This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.
        Returns:
        value or null for none
      • setEtag

        public DatabaseInstance setEtag(String etag)
        This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.
        Parameters:
        etag - etag or null for none
      • getFailoverReplica

        public DatabaseInstance.FailoverReplica getFailoverReplica()
        The name and status of the failover replica.
        Returns:
        value or null for none
      • getGceZone

        public String getGceZone()
        The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.
        Returns:
        value or null for none
      • setGceZone

        public DatabaseInstance setGceZone(String gceZone)
        The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.
        Parameters:
        gceZone - gceZone or null for none
      • getGeminiConfig

        public GeminiInstanceConfig getGeminiConfig()
        Gemini instance configuration.
        Returns:
        value or null for none
      • setGeminiConfig

        public DatabaseInstance setGeminiConfig(GeminiInstanceConfig geminiConfig)
        Gemini instance configuration.
        Parameters:
        geminiConfig - geminiConfig or null for none
      • getInstanceType

        public String getInstanceType()
        The instance type.
        Returns:
        value or null for none
      • setInstanceType

        public DatabaseInstance setInstanceType(String instanceType)
        The instance type.
        Parameters:
        instanceType - instanceType or null for none
      • getIpAddresses

        public List<IpMapping> getIpAddresses()
        The assigned IP addresses for the instance.
        Returns:
        value or null for none
      • setIpAddresses

        public DatabaseInstance setIpAddresses(List<IpMapping> ipAddresses)
        The assigned IP addresses for the instance.
        Parameters:
        ipAddresses - ipAddresses or null for none
      • getIpv6Address

        public String getIpv6Address()
        The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
        Returns:
        value or null for none
      • setIpv6Address

        public DatabaseInstance setIpv6Address(String ipv6Address)
        The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
        Parameters:
        ipv6Address - ipv6Address or null for none
      • getKind

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

        public DatabaseInstance setKind(String kind)
        This is always `sql#instance`.
        Parameters:
        kind - kind or null for none
      • getMaintenanceVersion

        public String getMaintenanceVersion()
        The current software version on the instance.
        Returns:
        value or null for none
      • setMaintenanceVersion

        public DatabaseInstance setMaintenanceVersion(String maintenanceVersion)
        The current software version on the instance.
        Parameters:
        maintenanceVersion - maintenanceVersion or null for none
      • getMasterInstanceName

        public String getMasterInstanceName()
        The name of the instance which will act as primary in the replication setup.
        Returns:
        value or null for none
      • setMasterInstanceName

        public DatabaseInstance setMasterInstanceName(String masterInstanceName)
        The name of the instance which will act as primary in the replication setup.
        Parameters:
        masterInstanceName - masterInstanceName or null for none
      • getMaxDiskSize

        public Long getMaxDiskSize()
        The maximum disk size of the instance in bytes.
        Returns:
        value or null for none
      • setMaxDiskSize

        public DatabaseInstance setMaxDiskSize(Long maxDiskSize)
        The maximum disk size of the instance in bytes.
        Parameters:
        maxDiskSize - maxDiskSize or null for none
      • getName

        public String getName()
        Name of the Cloud SQL instance. This does not include the project ID.
        Returns:
        value or null for none
      • setName

        public DatabaseInstance setName(String name)
        Name of the Cloud SQL instance. This does not include the project ID.
        Parameters:
        name - name or null for none
      • getOnPremisesConfiguration

        public OnPremisesConfiguration getOnPremisesConfiguration()
        Configuration specific to on-premises instances.
        Returns:
        value or null for none
      • setOnPremisesConfiguration

        public DatabaseInstance setOnPremisesConfiguration(OnPremisesConfiguration onPremisesConfiguration)
        Configuration specific to on-premises instances.
        Parameters:
        onPremisesConfiguration - onPremisesConfiguration or null for none
      • getOutOfDiskReport

        public SqlOutOfDiskReport getOutOfDiskReport()
        This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
        Returns:
        value or null for none
      • setOutOfDiskReport

        public DatabaseInstance setOutOfDiskReport(SqlOutOfDiskReport outOfDiskReport)
        This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
        Parameters:
        outOfDiskReport - outOfDiskReport or null for none
      • getPrimaryDnsName

        public String getPrimaryDnsName()
        Output only. DEPRECATED: please use write_endpoint instead.
        Returns:
        value or null for none
      • setPrimaryDnsName

        public DatabaseInstance setPrimaryDnsName(String primaryDnsName)
        Output only. DEPRECATED: please use write_endpoint instead.
        Parameters:
        primaryDnsName - primaryDnsName or null for none
      • getProject

        public String getProject()
        The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
        Returns:
        value or null for none
      • setProject

        public DatabaseInstance setProject(String project)
        The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
        Parameters:
        project - project or null for none
      • getPscServiceAttachmentLink

        public String getPscServiceAttachmentLink()
        Output only. The link to service attachment of PSC instance.
        Returns:
        value or null for none
      • setPscServiceAttachmentLink

        public DatabaseInstance setPscServiceAttachmentLink(String pscServiceAttachmentLink)
        Output only. The link to service attachment of PSC instance.
        Parameters:
        pscServiceAttachmentLink - pscServiceAttachmentLink or null for none
      • getRegion

        public String getRegion()
        The geographical region of the Cloud SQL instance. It can be one of the [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r) where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and `us-central1`. The default value is `us-central1`.
        Returns:
        value or null for none
      • setRegion

        public DatabaseInstance setRegion(String region)
        The geographical region of the Cloud SQL instance. It can be one of the [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r) where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and `us-central1`. The default value is `us-central1`.
        Parameters:
        region - region or null for none
      • getReplicaConfiguration

        public ReplicaConfiguration getReplicaConfiguration()
        Configuration specific to failover replicas and read replicas.
        Returns:
        value or null for none
      • setReplicaConfiguration

        public DatabaseInstance setReplicaConfiguration(ReplicaConfiguration replicaConfiguration)
        Configuration specific to failover replicas and read replicas.
        Parameters:
        replicaConfiguration - replicaConfiguration or null for none
      • getReplicaNames

        public List<String> getReplicaNames()
        The replicas of the instance.
        Returns:
        value or null for none
      • setReplicaNames

        public DatabaseInstance setReplicaNames(List<String> replicaNames)
        The replicas of the instance.
        Parameters:
        replicaNames - replicaNames or null for none
      • getReplicationCluster

        public ReplicationCluster getReplicationCluster()
        Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross- region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
        Returns:
        value or null for none
      • setReplicationCluster

        public DatabaseInstance setReplicationCluster(ReplicationCluster replicationCluster)
        Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross- region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
        Parameters:
        replicationCluster - replicationCluster or null for none
      • getRootPassword

        public String getRootPassword()
        Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
        Returns:
        value or null for none
      • setRootPassword

        public DatabaseInstance setRootPassword(String rootPassword)
        Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
        Parameters:
        rootPassword - rootPassword or null for none
      • getSatisfiesPzi

        public Boolean getSatisfiesPzi()
        Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.
        Returns:
        value or null for none
      • setSatisfiesPzi

        public DatabaseInstance setSatisfiesPzi(Boolean satisfiesPzi)
        Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.
        Parameters:
        satisfiesPzi - satisfiesPzi or null for none
      • getSatisfiesPzs

        public Boolean getSatisfiesPzs()
        This status indicates whether the instance satisfies PZS. The status is reserved for future use.
        Returns:
        value or null for none
      • setSatisfiesPzs

        public DatabaseInstance setSatisfiesPzs(Boolean satisfiesPzs)
        This status indicates whether the instance satisfies PZS. The status is reserved for future use.
        Parameters:
        satisfiesPzs - satisfiesPzs or null for none
      • getScheduledMaintenance

        public SqlScheduledMaintenance getScheduledMaintenance()
        The start time of any upcoming scheduled maintenance for this instance.
        Returns:
        value or null for none
      • setScheduledMaintenance

        public DatabaseInstance setScheduledMaintenance(SqlScheduledMaintenance scheduledMaintenance)
        The start time of any upcoming scheduled maintenance for this instance.
        Parameters:
        scheduledMaintenance - scheduledMaintenance or null for none
      • getSecondaryGceZone

        public String getSecondaryGceZone()
        The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.
        Returns:
        value or null for none
      • setSecondaryGceZone

        public DatabaseInstance setSecondaryGceZone(String secondaryGceZone)
        The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.
        Parameters:
        secondaryGceZone - secondaryGceZone or null for none
      • getSelfLink

        public String getSelfLink()
        The URI of this resource.
        Returns:
        value or null for none
      • setSelfLink

        public DatabaseInstance setSelfLink(String selfLink)
        The URI of this resource.
        Parameters:
        selfLink - selfLink or null for none
      • getServerCaCert

        public SslCert getServerCaCert()
        SSL configuration.
        Returns:
        value or null for none
      • setServerCaCert

        public DatabaseInstance setServerCaCert(SslCert serverCaCert)
        SSL configuration.
        Parameters:
        serverCaCert - serverCaCert or null for none
      • getServiceAccountEmailAddress

        public String getServiceAccountEmailAddress()
        The service account email address assigned to the instance.\This property is read-only.
        Returns:
        value or null for none
      • setServiceAccountEmailAddress

        public DatabaseInstance setServiceAccountEmailAddress(String serviceAccountEmailAddress)
        The service account email address assigned to the instance.\This property is read-only.
        Parameters:
        serviceAccountEmailAddress - serviceAccountEmailAddress or null for none
      • getSettings

        public Settings getSettings()
        The user settings.
        Returns:
        value or null for none
      • setSettings

        public DatabaseInstance setSettings(Settings settings)
        The user settings.
        Parameters:
        settings - settings or null for none
      • getSqlNetworkArchitecture

        public String getSqlNetworkArchitecture()
        Returns:
        value or null for none
      • setSqlNetworkArchitecture

        public DatabaseInstance setSqlNetworkArchitecture(String sqlNetworkArchitecture)
        Parameters:
        sqlNetworkArchitecture - sqlNetworkArchitecture or null for none
      • getState

        public String getState()
        The current serving state of the Cloud SQL instance.
        Returns:
        value or null for none
      • setState

        public DatabaseInstance setState(String state)
        The current serving state of the Cloud SQL instance.
        Parameters:
        state - state or null for none
      • getSuspensionReason

        public List<String> getSuspensionReason()
        If the instance state is SUSPENDED, the reason for the suspension.
        Returns:
        value or null for none
      • setSuspensionReason

        public DatabaseInstance setSuspensionReason(List<String> suspensionReason)
        If the instance state is SUSPENDED, the reason for the suspension.
        Parameters:
        suspensionReason - suspensionReason or null for none
      • getSwitchTransactionLogsToCloudStorageEnabled

        public Boolean getSwitchTransactionLogsToCloudStorageEnabled()
        Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
        Returns:
        value or null for none
      • setSwitchTransactionLogsToCloudStorageEnabled

        public DatabaseInstance setSwitchTransactionLogsToCloudStorageEnabled(Boolean switchTransactionLogsToCloudStorageEnabled)
        Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
        Parameters:
        switchTransactionLogsToCloudStorageEnabled - switchTransactionLogsToCloudStorageEnabled or null for none
      • getUpgradableDatabaseVersions

        public List<AvailableDatabaseVersion> getUpgradableDatabaseVersions()
        Output only. All database versions that are available for upgrade.
        Returns:
        value or null for none
      • setUpgradableDatabaseVersions

        public DatabaseInstance setUpgradableDatabaseVersions(List<AvailableDatabaseVersion> upgradableDatabaseVersions)
        Output only. All database versions that are available for upgrade.
        Parameters:
        upgradableDatabaseVersions - upgradableDatabaseVersions or null for none
      • getWriteEndpoint

        public String getWriteEndpoint()
        Output only. The dns name of the primary instance in a replication group.
        Returns:
        value or null for none
      • setWriteEndpoint

        public DatabaseInstance setWriteEndpoint(String writeEndpoint)
        Output only. The dns name of the primary instance in a replication group.
        Parameters:
        writeEndpoint - writeEndpoint or null for none
      • clone

        public DatabaseInstance 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