Console
    Contact Us Start free

    Google Cloud Gke Backup V1 Client - Class RestorePlan (1.2.0)

    Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class RestorePlan.

    The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.

    Generated from protobuf message google.cloud.gkebackup.v1.RestorePlan

    Namespace

    Google \ Cloud \ GkeBackup \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Output only. The full name of the RestorePlan resource. Format: projects/*/locations/*/restorePlans/* .

    ↳ uid
    string

    Output only. Server generated global unique identifier of UUID format.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The timestamp when this RestorePlan resource was created.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. The timestamp when this RestorePlan resource was last updated.

    ↳ description
    string

    Optional. User specified descriptive string for this RestorePlan.

    ↳ backup_plan
    string

    Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/* .

    ↳ cluster
    string

    Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

    ↳ restore_config
    RestoreConfig

    Required. Configuration of Restores created via this RestorePlan.

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    Optional. A set of custom labels supplied by user.

    ↳ etag
    string

    Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestorePlan , and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

    ↳ state
    int

    Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

    ↳ state_reason
    string

    Output only. Human-readable description of why RestorePlan is in the current state . This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.

    ↳ restore_channel
    string

    Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the backup_plan is in a different project than the RestorePlan. Format: projects/*/locations/*/restoreChannels/*

    getName

    Output only. The full name of the RestorePlan resource.

    Format: projects/*/locations/*/restorePlans/* .

    Returns
    Type
    Description
    string

    setName

    Output only. The full name of the RestorePlan resource.

    Format: projects/*/locations/*/restorePlans/* .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getUid

    Output only. Server generated global unique identifier of UUID format.

    Returns
    Type
    Description
    string

    setUid

    Output only. Server generated global unique identifier of UUID format.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. The timestamp when this RestorePlan resource was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The timestamp when this RestorePlan resource was created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. The timestamp when this RestorePlan resource was last updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. The timestamp when this RestorePlan resource was last updated.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getDescription

    Optional. User specified descriptive string for this RestorePlan.

    Returns
    Type
    Description
    string

    setDescription

    Optional. User specified descriptive string for this RestorePlan.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getBackupPlan

    Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/* .

    Returns
    Type
    Description
    string

    setBackupPlan

    Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/* .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCluster

    Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

    • projects/*/locations/*/clusters/*
    • projects/*/zones/*/clusters/*
    Returns
    Type
    Description
    string

    setCluster

    Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

    • projects/*/locations/*/clusters/*
    • projects/*/zones/*/clusters/*
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRestoreConfig

    Required. Configuration of Restores created via this RestorePlan.

    Returns
    Type
    Description
    RestoreConfig |null

    hasRestoreConfig

    clearRestoreConfig

    setRestoreConfig

    Required. Configuration of Restores created via this RestorePlan.

    Parameter
    Name
    Description
    var
    RestoreConfig
    Returns
    Type
    Description
    $this

    getLabels

    Optional. A set of custom labels supplied by user.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Optional. A set of custom labels supplied by user.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getEtag

    Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other.

    It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestorePlan , and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

    Returns
    Type
    Description
    string

    setEtag

    Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other.

    It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestorePlan , and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getState

    Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

    Returns
    Type
    Description
    int

    setState

    Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getStateReason

    Output only. Human-readable description of why RestorePlan is in the current state . This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.

    Returns
    Type
    Description
    string

    setStateReason

    Output only. Human-readable description of why RestorePlan is in the current state . This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRestoreChannel

    Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the backup_plan is in a different project than the RestorePlan. Format: projects/*/locations/*/restoreChannels/*

    Returns
    Type
    Description
    string

    setRestoreChannel

    Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the backup_plan is in a different project than the RestorePlan. Format: projects/*/locations/*/restoreChannels/*

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