Reference documentation and code samples for the Maintenance V1 API class Google::Cloud::Maintenance::Api::V1::ResourceMaintenance.
ResourceMaintenance is a resource that represents a maintenance operation on a resource.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotations
def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
-
(::Google::Protobuf::Map{::String => ::String}) — Optional. Annotations is an unstructured key-value map stored with a
resource that may be set by external tools to store and retrieve arbitrary
metadata. They are not queryable and should be preserved when modifying
objects.
More info: https://kubernetes.io/docs/user-guide/annotations
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
-
value (::Google::Protobuf::Map{::String => ::String}) — Optional. Annotations is an unstructured key-value map stored with a
resource that may be set by external tools to store and retrieve arbitrary
metadata. They are not queryable and should be preserved when modifying
objects.
More info: https://kubernetes.io/docs/user-guide/annotations
Returns
-
(::Google::Protobuf::Map{::String => ::String}) — Optional. Annotations is an unstructured key-value map stored with a
resource that may be set by external tools to store and retrieve arbitrary
metadata. They are not queryable and should be preserved when modifying
objects.
More info: https://kubernetes.io/docs/user-guide/annotations
#controls
def controls() -> ::Array<::Google::Cloud::Maintenance::Api::V1::MaintenanceControl>
Returns
- (::Array<::Google::Cloud::Maintenance::Api::V1::MaintenanceControl>) — Output only. The controls of the maintenance.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The create time of the resource maintenance.
#etag
def etag() -> ::String
Returns
- (::String) — Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
#maintenance
def maintenance() -> ::Google::Cloud::Maintenance::Api::V1::ResourceMaintenance::Maintenance
Returns
- (::Google::Cloud::Maintenance::Api::V1::ResourceMaintenance::Maintenance) — Output only. The details of the maintenance.
#maintenance_cancel_time
def maintenance_cancel_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the resource maintenance was cancelled.
#maintenance_end_time
def maintenance_end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the resource maintenance has completed.
#maintenance_scheduled_end_time
def maintenance_scheduled_end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the maintenance on the resource was scheduled to end.
#maintenance_scheduled_start_time
def maintenance_scheduled_start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the maintenance on the resource was scheduled to start.
#maintenance_start_time
def maintenance_start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the resource maintenance has started.
#name
def name() -> ::String
Returns
-
(::String) — Identifier. The name of the resource_maintenance resource.
Format:
"projects/{project}/locations/{location}/resourceMaintenance/{resource-maintenance-id}"
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. The name of the resource_maintenance resource.
Format:
"projects/{project}/locations/{location}/resourceMaintenance/{resource-maintenance-id}"
Returns
-
(::String) — Identifier. The name of the resource_maintenance resource.
Format:
"projects/{project}/locations/{location}/resourceMaintenance/{resource-maintenance-id}"
#resource
def resource() -> ::Google::Cloud::Maintenance::Api::V1::ResourceMaintenance::Resource
Returns
- (::Google::Cloud::Maintenance::Api::V1::ResourceMaintenance::Resource) — Output only. The resource spec of the resource maintenance.
#state
def state() -> ::Google::Cloud::Maintenance::Api::V1::ResourceMaintenance::State
Returns
- (::Google::Cloud::Maintenance::Api::V1::ResourceMaintenance::State) — Output only. The state of the resource maintenance.
#uid
def uid() -> ::String
Returns
- (::String) — Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The update time of the resource maintenance.
#user_controllable
def user_controllable() -> ::Boolean
Returns
- (::Boolean) — Output only. Indicates whether the user has some control over that maintenance, either proactively before maintenance was scheduled with maintenance policy or with reactive controls after it was scheduled (see controls field)