Console
    Start free

    Google Cloud Sql Admin V1 Client - Class InstancesRestoreBackupRequest (1.8.0)

    Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class InstancesRestoreBackupRequest.

    Database instance restore backup request.

    Generated from protobuf message google.cloud.sql.v1.InstancesRestoreBackupRequest

    Namespace

    Google \ Cloud \ Sql \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ restore_backup_context
    RestoreBackupContext

    Parameters required to perform the restore backup operation.

    ↳ backup
    string

    The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.

    ↳ backupdr_backup
    string

    The name of the backup that's used to restore a Cloud SQL instance: Format: "projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}". Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.

    ↳ restore_instance_settings
    DatabaseInstance

    Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances.

    ↳ restore_instance_clear_overrides_field_names
    string[]

    Optional. This field has the same purpose as restore_instance_settings, changes any instance settings stored in the backup you are restoring from. With the difference that these fields are cleared in the settings.

    getRestoreBackupContext

    Parameters required to perform the restore backup operation.

    Returns
    Type
    Description
    RestoreBackupContext |null

    hasRestoreBackupContext

    clearRestoreBackupContext

    setRestoreBackupContext

    Parameters required to perform the restore backup operation.

    Parameter
    Name
    Description
    var
    RestoreBackupContext
    Returns
    Type
    Description
    $this

    getBackup

    The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.

    Returns
    Type
    Description
    string

    setBackup

    The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getBackupdrBackup

    The name of the backup that's used to restore a Cloud SQL instance: Format: "projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}".

    Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.

    Returns
    Type
    Description
    string

    setBackupdrBackup

    The name of the backup that's used to restore a Cloud SQL instance: Format: "projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}".

    Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRestoreInstanceSettings

    Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size.

    You can use this field to restore new instances only. This field is not applicable for restore to existing instances.

    Returns
    Type
    Description
    DatabaseInstance |null

    hasRestoreInstanceSettings

    clearRestoreInstanceSettings

    setRestoreInstanceSettings

    Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size.

    You can use this field to restore new instances only. This field is not applicable for restore to existing instances.

    Parameter
    Name
    Description
    var
    DatabaseInstance
    Returns
    Type
    Description
    $this

    getRestoreInstanceClearOverridesFieldNames

    Optional. This field has the same purpose as restore_instance_settings, changes any instance settings stored in the backup you are restoring from.

    With the difference that these fields are cleared in the settings.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < string >

    setRestoreInstanceClearOverridesFieldNames

    Optional. This field has the same purpose as restore_instance_settings, changes any instance settings stored in the backup you are restoring from.

    With the difference that these fields are cleared in the settings.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: