Class: Google::Apis::DeploymentmanagerV2::Operation
- Inherits:
-
Object
- Object
- Google::Apis::DeploymentmanagerV2::Operation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/deploymentmanager_v2/classes.rb,
generated/google/apis/deploymentmanager_v2/representations.rb,
generated/google/apis/deploymentmanager_v2/representations.rb
Overview
An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta. regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Defined Under Namespace
Instance Attribute Summary collapse
-
#client_operation_id ⇒ String
[Output Only] The value of
requestId
if you provided it in the request. -
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
-
#description ⇒ String
[Output Only] A textual description of the operation, which is set when the operation is created.
-
#end_time ⇒ String
[Output Only] The time that this operation was completed.
-
#error ⇒ Google::Apis::DeploymentmanagerV2::Operation::Error
[Output Only] If errors are generated during processing of the operation, this field will be populated.
-
#http_error_message ⇒ String
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-
#http_error_status_code ⇒ Fixnum
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#insert_time ⇒ String
[Output Only] The time that this operation was requested.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#name ⇒ String
[Output Only] Name of the resource.
-
#operation_type ⇒ String
[Output Only] The type of operation, such as insert, update, or delete, and so on.
-
#progress ⇒ Fixnum
[Output Only] An optional progress indicator that ranges from 0 to 100.
-
#region ⇒ String
[Output Only] The URL of the region where the operation resides.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#start_time ⇒ String
[Output Only] The time that this operation was started by the server.
-
#status ⇒ String
[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
-
#status_message ⇒ String
[Output Only] An optional textual description of the current status of the operation.
-
#target_id ⇒ Fixnum
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-
#target_link ⇒ String
[Output Only] The URL of the resource that the operation modifies.
-
#user ⇒ String
[Output Only] User who requested the operation, for example: user@example.com.
-
#warnings ⇒ Array<Google::Apis::DeploymentmanagerV2::Operation::Warning>
[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-
#zone ⇒ String
[Output Only] The URL of the zone where the operation resides.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Operation
constructor
A new instance of Operation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Operation
Returns a new instance of Operation
996 997 998 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 996 def initialize(**args) update!(**args) end |
Instance Attribute Details
#client_operation_id ⇒ String
[Output Only] The value of requestId
if you provided it in the request. Not
present otherwise.
Corresponds to the JSON property clientOperationId
859 860 861 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 859 def client_operation_id @client_operation_id end |
#creation_timestamp ⇒ String
[Deprecated] This field is deprecated.
Corresponds to the JSON property creationTimestamp
864 865 866 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 864 def @creation_timestamp end |
#description ⇒ String
[Output Only] A textual description of the operation, which is set when the
operation is created.
Corresponds to the JSON property description
870 871 872 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 870 def description @description end |
#end_time ⇒ String
[Output Only] The time that this operation was completed. This value is in
RFC3339 text format.
Corresponds to the JSON property endTime
876 877 878 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 876 def end_time @end_time end |
#error ⇒ Google::Apis::DeploymentmanagerV2::Operation::Error
[Output Only] If errors are generated during processing of the operation, this
field will be populated.
Corresponds to the JSON property error
882 883 884 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 882 def error @error end |
#http_error_message ⇒ String
[Output Only] If the operation fails, this field contains the HTTP error
message that was returned, such as NOT FOUND.
Corresponds to the JSON property httpErrorMessage
888 889 890 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 888 def @http_error_message end |
#http_error_status_code ⇒ Fixnum
[Output Only] If the operation fails, this field contains the HTTP error
status code that was returned. For example, a 404 means the resource was not
found.
Corresponds to the JSON property httpErrorStatusCode
895 896 897 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 895 def http_error_status_code @http_error_status_code end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
901 902 903 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 901 def id @id end |
#insert_time ⇒ String
[Output Only] The time that this operation was requested. This value is in
RFC3339 text format.
Corresponds to the JSON property insertTime
907 908 909 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 907 def insert_time @insert_time end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#operation for Operation
resources.
Corresponds to the JSON property kind
913 914 915 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 913 def kind @kind end |
#name ⇒ String
[Output Only] Name of the resource.
Corresponds to the JSON property name
918 919 920 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 918 def name @name end |
#operation_type ⇒ String
[Output Only] The type of operation, such as insert, update, or delete, and so
on.
Corresponds to the JSON property operationType
924 925 926 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 924 def operation_type @operation_type end |
#progress ⇒ Fixnum
[Output Only] An optional progress indicator that ranges from 0 to 100. There
is no requirement that this be linear or support any granularity of operations.
This should not be used to guess when the operation will be complete. This
number should monotonically increase as the operation progresses.
Corresponds to the JSON property progress
932 933 934 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 932 def progress @progress end |
#region ⇒ String
[Output Only] The URL of the region where the operation resides. Only
available when performing regional operations. You must specify this field as
part of the HTTP request URL. It is not settable as a field in the request
body.
Corresponds to the JSON property region
940 941 942 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 940 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
945 946 947 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 945 def self_link @self_link end |
#start_time ⇒ String
[Output Only] The time that this operation was started by the server. This
value is in RFC3339 text format.
Corresponds to the JSON property startTime
951 952 953 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 951 def start_time @start_time end |
#status ⇒ String
[Output Only] The status of the operation, which can be one of the following:
PENDING, RUNNING, or DONE.
Corresponds to the JSON property status
957 958 959 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 957 def status @status end |
#status_message ⇒ String
[Output Only] An optional textual description of the current status of the
operation.
Corresponds to the JSON property statusMessage
963 964 965 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 963 def @status_message end |
#target_id ⇒ Fixnum
[Output Only] The unique target ID, which identifies a specific incarnation of
the target resource.
Corresponds to the JSON property targetId
969 970 971 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 969 def target_id @target_id end |
#target_link ⇒ String
[Output Only] The URL of the resource that the operation modifies. For
operations related to creating a snapshot, this points to the persistent disk
that the snapshot was created from.
Corresponds to the JSON property targetLink
976 977 978 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 976 def target_link @target_link end |
#user ⇒ String
[Output Only] User who requested the operation, for example: user@example.com.
Corresponds to the JSON property user
981 982 983 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 981 def user @user end |
#warnings ⇒ Array<Google::Apis::DeploymentmanagerV2::Operation::Warning>
[Output Only] If warning messages are generated during processing of the
operation, this field will be populated.
Corresponds to the JSON property warnings
987 988 989 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 987 def warnings @warnings end |
#zone ⇒ String
[Output Only] The URL of the zone where the operation resides. Only available
when performing per-zone operations. You must specify this field as part of
the HTTP request URL. It is not settable as a field in the request body.
Corresponds to the JSON property zone
994 995 996 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 994 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 |
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 1001 def update!(**args) @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @end_time = args[:end_time] if args.key?(:end_time) @error = args[:error] if args.key?(:error) @http_error_message = args[:http_error_message] if args.key?(:http_error_message) @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code) @id = args[:id] if args.key?(:id) @insert_time = args[:insert_time] if args.key?(:insert_time) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @operation_type = args[:operation_type] if args.key?(:operation_type) @progress = args[:progress] if args.key?(:progress) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @target_id = args[:target_id] if args.key?(:target_id) @target_link = args[:target_link] if args.key?(:target_link) @user = args[:user] if args.key?(:user) @warnings = args[:warnings] if args.key?(:warnings) @zone = args[:zone] if args.key?(:zone) end |