Class: Google::Cloud::GkeBackup::V1::BackupPlanBinding

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb

Overview

A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.

Defined Under Namespace

Classes: BackupPlanDetails

Instance Attribute Summary collapse

Instance Attribute Details

#backup_plan ⇒ ::String (readonly)

Returns Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. projects/*/locations/*/backupPlans/{backup_plan}.

Returns:

  • (::String) —

    Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. projects/*/locations/*/backupPlans/{backup_plan}



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb', line 68

class BackupPlanBinding
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains metadata about the backup plan/backup.
  # @!attribute [r] protected_pod_count
  #   @return [::Integer]
  #     Output only. The number of Kubernetes Pods backed up in the
  #     last successful Backup created via this BackupPlan.
  # @!attribute [r] state
  #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails::State]
  #     Output only. State of the BackupPlan.
  # @!attribute [r] last_successful_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Completion time of the last successful Backup. This is
  #     sourced from a successful Backup's complete_time field.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config. This is sourced from BackupPlan.
  # @!attribute [r] rpo_risk_level
  #   @return [::Integer]
  #     Output only. A number that represents the current risk level of this
  #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
  #     risk.
  # @!attribute [r] last_successful_backup
  #   @return [::String]
  #     Output only. The fully qualified name of the last successful Backup
  #     created under this BackupPlan.
  #     `projects/*/locations/*/backupPlans/*/backups/*`
  class BackupPlanDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State
    module State
      # Default first value for Enums.
      STATE_UNSPECIFIED = 0

      # Waiting for cluster state to be RUNNING.
      CLUSTER_PENDING = 1

      # The BackupPlan is in the process of being created.
      PROVISIONING = 2

      # The BackupPlan has successfully been created and is ready for Backups.
      READY = 3

      # BackupPlan creation has failed.
      FAILED = 4

      # The BackupPlan has been deactivated.
      DEACTIVATED = 5

      # The BackupPlan is in the process of being deleted.
      DELETING = 6
    end
  end
end

#backup_plan_details ⇒ ::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails (readonly)

Returns Output only. Contains details about the backup plan/backup.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb', line 68

class BackupPlanBinding
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains metadata about the backup plan/backup.
  # @!attribute [r] protected_pod_count
  #   @return [::Integer]
  #     Output only. The number of Kubernetes Pods backed up in the
  #     last successful Backup created via this BackupPlan.
  # @!attribute [r] state
  #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails::State]
  #     Output only. State of the BackupPlan.
  # @!attribute [r] last_successful_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Completion time of the last successful Backup. This is
  #     sourced from a successful Backup's complete_time field.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config. This is sourced from BackupPlan.
  # @!attribute [r] rpo_risk_level
  #   @return [::Integer]
  #     Output only. A number that represents the current risk level of this
  #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
  #     risk.
  # @!attribute [r] last_successful_backup
  #   @return [::String]
  #     Output only. The fully qualified name of the last successful Backup
  #     created under this BackupPlan.
  #     `projects/*/locations/*/backupPlans/*/backups/*`
  class BackupPlanDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State
    module State
      # Default first value for Enums.
      STATE_UNSPECIFIED = 0

      # Waiting for cluster state to be RUNNING.
      CLUSTER_PENDING = 1

      # The BackupPlan is in the process of being created.
      PROVISIONING = 2

      # The BackupPlan has successfully been created and is ready for Backups.
      READY = 3

      # BackupPlan creation has failed.
      FAILED = 4

      # The BackupPlan has been deactivated.
      DEACTIVATED = 5

      # The BackupPlan is in the process of being deleted.
      DELETING = 6
    end
  end
end

#cluster ⇒ ::String (readonly)

Returns Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*.

Returns:

  • (::String) —

    Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats:

    • projects/*/locations/*/clusters/*
    • projects/*/zones/*/clusters/*


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb', line 68

class BackupPlanBinding
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains metadata about the backup plan/backup.
  # @!attribute [r] protected_pod_count
  #   @return [::Integer]
  #     Output only. The number of Kubernetes Pods backed up in the
  #     last successful Backup created via this BackupPlan.
  # @!attribute [r] state
  #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails::State]
  #     Output only. State of the BackupPlan.
  # @!attribute [r] last_successful_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Completion time of the last successful Backup. This is
  #     sourced from a successful Backup's complete_time field.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config. This is sourced from BackupPlan.
  # @!attribute [r] rpo_risk_level
  #   @return [::Integer]
  #     Output only. A number that represents the current risk level of this
  #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
  #     risk.
  # @!attribute [r] last_successful_backup
  #   @return [::String]
  #     Output only. The fully qualified name of the last successful Backup
  #     created under this BackupPlan.
  #     `projects/*/locations/*/backupPlans/*/backups/*`
  class BackupPlanDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State
    module State
      # Default first value for Enums.
      STATE_UNSPECIFIED = 0

      # Waiting for cluster state to be RUNNING.
      CLUSTER_PENDING = 1

      # The BackupPlan is in the process of being created.
      PROVISIONING = 2

      # The BackupPlan has successfully been created and is ready for Backups.
      READY = 3

      # BackupPlan creation has failed.
      FAILED = 4

      # The BackupPlan has been deactivated.
      DEACTIVATED = 5

      # The BackupPlan is in the process of being deleted.
      DELETING = 6
    end
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when this binding was created.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb', line 68

class BackupPlanBinding
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains metadata about the backup plan/backup.
  # @!attribute [r] protected_pod_count
  #   @return [::Integer]
  #     Output only. The number of Kubernetes Pods backed up in the
  #     last successful Backup created via this BackupPlan.
  # @!attribute [r] state
  #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails::State]
  #     Output only. State of the BackupPlan.
  # @!attribute [r] last_successful_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Completion time of the last successful Backup. This is
  #     sourced from a successful Backup's complete_time field.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config. This is sourced from BackupPlan.
  # @!attribute [r] rpo_risk_level
  #   @return [::Integer]
  #     Output only. A number that represents the current risk level of this
  #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
  #     risk.
  # @!attribute [r] last_successful_backup
  #   @return [::String]
  #     Output only. The fully qualified name of the last successful Backup
  #     created under this BackupPlan.
  #     `projects/*/locations/*/backupPlans/*/backups/*`
  class BackupPlanDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State
    module State
      # Default first value for Enums.
      STATE_UNSPECIFIED = 0

      # Waiting for cluster state to be RUNNING.
      CLUSTER_PENDING = 1

      # The BackupPlan is in the process of being created.
      PROVISIONING = 2

      # The BackupPlan has successfully been created and is ready for Backups.
      READY = 3

      # BackupPlan creation has failed.
      FAILED = 4

      # The BackupPlan has been deactivated.
      DEACTIVATED = 5

      # The BackupPlan is in the process of being deleted.
      DELETING = 6
    end
  end
end

#etag ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb', line 68

class BackupPlanBinding
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains metadata about the backup plan/backup.
  # @!attribute [r] protected_pod_count
  #   @return [::Integer]
  #     Output only. The number of Kubernetes Pods backed up in the
  #     last successful Backup created via this BackupPlan.
  # @!attribute [r] state
  #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails::State]
  #     Output only. State of the BackupPlan.
  # @!attribute [r] last_successful_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Completion time of the last successful Backup. This is
  #     sourced from a successful Backup's complete_time field.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config. This is sourced from BackupPlan.
  # @!attribute [r] rpo_risk_level
  #   @return [::Integer]
  #     Output only. A number that represents the current risk level of this
  #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
  #     risk.
  # @!attribute [r] last_successful_backup
  #   @return [::String]
  #     Output only. The fully qualified name of the last successful Backup
  #     created under this BackupPlan.
  #     `projects/*/locations/*/backupPlans/*/backups/*`
  class BackupPlanDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State
    module State
      # Default first value for Enums.
      STATE_UNSPECIFIED = 0

      # Waiting for cluster state to be RUNNING.
      CLUSTER_PENDING = 1

      # The BackupPlan is in the process of being created.
      PROVISIONING = 2

      # The BackupPlan has successfully been created and is ready for Backups.
      READY = 3

      # BackupPlan creation has failed.
      FAILED = 4

      # The BackupPlan has been deactivated.
      DEACTIVATED = 5

      # The BackupPlan is in the process of being deleted.
      DELETING = 6
    end
  end
end

#name ⇒ ::String

Returns Identifier. The fully qualified name of the BackupPlanBinding. projects/*/locations/*/backupChannels/*/backupPlanBindings/*.

Returns:

  • (::String) —

    Identifier. The fully qualified name of the BackupPlanBinding. projects/*/locations/*/backupChannels/*/backupPlanBindings/*



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb', line 68

class BackupPlanBinding
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains metadata about the backup plan/backup.
  # @!attribute [r] protected_pod_count
  #   @return [::Integer]
  #     Output only. The number of Kubernetes Pods backed up in the
  #     last successful Backup created via this BackupPlan.
  # @!attribute [r] state
  #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails::State]
  #     Output only. State of the BackupPlan.
  # @!attribute [r] last_successful_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Completion time of the last successful Backup. This is
  #     sourced from a successful Backup's complete_time field.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config. This is sourced from BackupPlan.
  # @!attribute [r] rpo_risk_level
  #   @return [::Integer]
  #     Output only. A number that represents the current risk level of this
  #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
  #     risk.
  # @!attribute [r] last_successful_backup
  #   @return [::String]
  #     Output only. The fully qualified name of the last successful Backup
  #     created under this BackupPlan.
  #     `projects/*/locations/*/backupPlans/*/backups/*`
  class BackupPlanDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State
    module State
      # Default first value for Enums.
      STATE_UNSPECIFIED = 0

      # Waiting for cluster state to be RUNNING.
      CLUSTER_PENDING = 1

      # The BackupPlan is in the process of being created.
      PROVISIONING = 2

      # The BackupPlan has successfully been created and is ready for Backups.
      READY = 3

      # BackupPlan creation has failed.
      FAILED = 4

      # The BackupPlan has been deactivated.
      DEACTIVATED = 5

      # The BackupPlan is in the process of being deleted.
      DELETING = 6
    end
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. Server generated global unique identifier of UUID4.

Returns:

  • (::String) —

    Output only. Server generated global unique identifier of UUID4



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb', line 68

class BackupPlanBinding
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains metadata about the backup plan/backup.
  # @!attribute [r] protected_pod_count
  #   @return [::Integer]
  #     Output only. The number of Kubernetes Pods backed up in the
  #     last successful Backup created via this BackupPlan.
  # @!attribute [r] state
  #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails::State]
  #     Output only. State of the BackupPlan.
  # @!attribute [r] last_successful_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Completion time of the last successful Backup. This is
  #     sourced from a successful Backup's complete_time field.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config. This is sourced from BackupPlan.
  # @!attribute [r] rpo_risk_level
  #   @return [::Integer]
  #     Output only. A number that represents the current risk level of this
  #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
  #     risk.
  # @!attribute [r] last_successful_backup
  #   @return [::String]
  #     Output only. The fully qualified name of the last successful Backup
  #     created under this BackupPlan.
  #     `projects/*/locations/*/backupPlans/*/backups/*`
  class BackupPlanDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State
    module State
      # Default first value for Enums.
      STATE_UNSPECIFIED = 0

      # Waiting for cluster state to be RUNNING.
      CLUSTER_PENDING = 1

      # The BackupPlan is in the process of being created.
      PROVISIONING = 2

      # The BackupPlan has successfully been created and is ready for Backups.
      READY = 3

      # BackupPlan creation has failed.
      FAILED = 4

      # The BackupPlan has been deactivated.
      DEACTIVATED = 5

      # The BackupPlan is in the process of being deleted.
      DELETING = 6
    end
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when this binding was created.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb', line 68

class BackupPlanBinding
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains metadata about the backup plan/backup.
  # @!attribute [r] protected_pod_count
  #   @return [::Integer]
  #     Output only. The number of Kubernetes Pods backed up in the
  #     last successful Backup created via this BackupPlan.
  # @!attribute [r] state
  #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails::State]
  #     Output only. State of the BackupPlan.
  # @!attribute [r] last_successful_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Completion time of the last successful Backup. This is
  #     sourced from a successful Backup's complete_time field.
  # @!attribute [r] next_scheduled_backup_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. Start time of next scheduled backup under this BackupPlan by
  #     either cron_schedule or rpo config. This is sourced from BackupPlan.
  # @!attribute [r] rpo_risk_level
  #   @return [::Integer]
  #     Output only. A number that represents the current risk level of this
  #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
  #     risk.
  # @!attribute [r] last_successful_backup
  #   @return [::String]
  #     Output only. The fully qualified name of the last successful Backup
  #     created under this BackupPlan.
  #     `projects/*/locations/*/backupPlans/*/backups/*`
  class BackupPlanDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State
    module State
      # Default first value for Enums.
      STATE_UNSPECIFIED = 0

      # Waiting for cluster state to be RUNNING.
      CLUSTER_PENDING = 1

      # The BackupPlan is in the process of being created.
      PROVISIONING = 2

      # The BackupPlan has successfully been created and is ready for Backups.
      READY = 3

      # BackupPlan creation has failed.
      FAILED = 4

      # The BackupPlan has been deactivated.
      DEACTIVATED = 5

      # The BackupPlan is in the process of being deleted.
      DELETING = 6
    end
  end
end