Class: Google::Cloud::BackupDR::V1::BackupPlan

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

Overview

A BackupPlan specifies some common fields, such as description as well as one or more BackupRule messages. Each BackupRule has a retention policy and defines a schedule by which the system is to perform backup workloads.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#backup_rules ⇒ ::Array<::Google::Cloud::BackupDR::V1::BackupRule>

Returns Required. The backup rules for this BackupPlan. There must be at least one BackupRule message.

Returns:



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#backup_vault ⇒ ::String

Returns Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}.

Returns:

  • (::String) —

    Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#backup_vault_service_account ⇒ ::String (readonly)

Returns Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.

Returns:

  • (::String) —

    Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

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

Returns Output only. When the BackupPlan was created.

Returns:



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#description ⇒ ::String

Returns Optional. The description of the BackupPlan resource.

The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.

Returns:

  • (::String) —

    Optional. The description of the BackupPlan resource.

    The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#etag ⇒ ::String

Returns Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.

Returns:

  • (::String) —

    Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#log_retention_days ⇒ ::Integer

Returns Optional. Applicable only for CloudSQL resource_type.

Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.

Returns:

  • (::Integer) —

    Optional. Applicable only for CloudSQL resource_type.

    Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Identifier. The resource name of the BackupPlan.

Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}.

Returns:

  • (::String) —

    Output only. Identifier. The resource name of the BackupPlan.

    Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#resource_type ⇒ ::String

Returns Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".

Returns:

  • (::String) —

    Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#revision_id ⇒ ::String (readonly)

Returns Output only. The user friendly revision ID of the BackupPlanRevision.

Example: v0, v1, v2, etc.

Returns:

  • (::String) —

    Output only. The user friendly revision ID of the BackupPlanRevision.

    Example: v0, v1, v2, etc.



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#revision_name ⇒ ::String (readonly)

Returns Output only. The resource id of the BackupPlanRevision.

Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}.

Returns:

  • (::String) —

    Output only. The resource id of the BackupPlanRevision.

    Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#state ⇒ ::Google::Cloud::BackupDR::V1::BackupPlan::State (readonly)

Returns Output only. The State for the BackupPlan.

Returns:



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

#supported_resource_types ⇒ ::Array<::String> (readonly)

Returns Output only. All resource types to which backupPlan can be applied.

Returns:

  • (::Array<::String>) —

    Output only. All resource types to which backupPlan can be applied.



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end

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

Returns Output only. When the BackupPlan was last updated.

Returns:



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
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 100

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `State` enumerates the possible states for a `BackupPlan`.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The resource is being created.
    CREATING = 1

    # The resource has been created and is fully usable.
    ACTIVE = 2

    # The resource is being deleted.
    DELETING = 3

    # The resource has been created but is not usable.
    INACTIVE = 4

    # The resource is being updated.
    UPDATING = 5
  end
end