Class: Google::Apis::DataprocV1::Operation
- Inherits:
-
Object
- Object
- Google::Apis::DataprocV1::Operation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dataproc_v1/classes.rb,
generated/google/apis/dataproc_v1/representations.rb,
generated/google/apis/dataproc_v1/representations.rb
Overview
This resource represents a long-running operation that is the result of a network API call.
Instance Attribute Summary collapse
-
#done ⇒ Boolean
(also: #done?)
If the value is false, it means the operation is still in progress.
-
#error ⇒ Google::Apis::DataprocV1::Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
-
#metadata ⇒ Hash<String,Object>
Service-specific metadata associated with the operation.
-
#name ⇒ String
The server-assigned name, which is only unique within the same service that originally returns it.
-
#response ⇒ Hash<String,Object>
The normal response of the operation in case of success.
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
1555 1556 1557 |
# File 'generated/google/apis/dataproc_v1/classes.rb', line 1555 def initialize(**args) update!(**args) end |
Instance Attribute Details
#done ⇒ Boolean Also known as: done?
If the value is false, it means the operation is still in progress. If true,
the operation is completed, and either error or response is available.
Corresponds to the JSON property done
1488 1489 1490 |
# File 'generated/google/apis/dataproc_v1/classes.rb', line 1488 def done @done end |
#error ⇒ Google::Apis::DataprocV1::Status
The Status type defines a logical error model that is suitable for different
programming environments, including REST APIs and RPC APIs. It is used by gRPC
(https://github.com/grpc). The error model is designed to be:
Simple to use and understand for most users
Flexible enough to meet unexpected needsOverviewThe Status message contains
three pieces of data: error code, error message, and error details. The error
code should be an enum value of google.rpc.Code, but it may accept additional
error codes if needed. The error message should be a developer-facing English
message that helps developers understand and resolve the error. If a localized
user-facing error message is needed, put the localized message in the error
details or localize it in the client. The optional error details may contain
arbitrary information about the error. There is a predefined set of error
detail types in the package google.rpc that can be used for common error
conditions.Language mappingThe Status message is the logical representation of
the error model, but it is not necessarily the actual wire format. When the
Status message is exposed in different client libraries and different wire
protocols, it can be mapped differently. For example, it will likely be mapped
to some exceptions in Java, but more likely mapped to some error codes in C.
Other usesThe error model and the Status message can be used in a variety of
environments, either with or without APIs, to provide a consistent developer
experience across different environments.Example uses of this error model
include:
Partial errors. If a service needs to return partial errors to the client, it
may embed the Status in the normal response to indicate the partial errors.
Workflow errors. A typical workflow has multiple steps. Each step may have a
Status message for error reporting.
Batch operations. If a client uses batch request and batch response, the
Status message should be used directly inside batch response, one for each
error sub-response.
Asynchronous operations. If an API call embeds asynchronous operation results
in its response, the status of those operations should be represented directly
using the Status message.
Logging. If some API errors are stored in logs, the message Status could be
used directly after any stripping needed for security/privacy reasons.
Corresponds to the JSON property error
1527 1528 1529 |
# File 'generated/google/apis/dataproc_v1/classes.rb', line 1527 def error @error end |
#metadata ⇒ Hash<String,Object>
Service-specific metadata associated with the operation. It typically contains
progress information and common metadata such as create time. Some services
might not provide such metadata. Any method that returns a long-running
operation should document the metadata type, if any.
Corresponds to the JSON property metadata
1535 1536 1537 |
# File 'generated/google/apis/dataproc_v1/classes.rb', line 1535 def @metadata end |
#name ⇒ String
The server-assigned name, which is only unique within the same service that
originally returns it. If you use the default HTTP mapping, the name should
have the format of operations/some/unique/name.
Corresponds to the JSON property name
1542 1543 1544 |
# File 'generated/google/apis/dataproc_v1/classes.rb', line 1542 def name @name end |
#response ⇒ Hash<String,Object>
The normal response of the operation in case of success. If the original
method returns no data on success, such as Delete, the response is google.
protobuf.Empty. If the original method is standard Get/Create/Update, the
response should be the resource. For other methods, the response should have
the type XxxResponse, where Xxx is the original method name. For example, if
the original method name is TakeSnapshot(), the inferred response type is
TakeSnapshotResponse.
Corresponds to the JSON property response
1553 1554 1555 |
# File 'generated/google/apis/dataproc_v1/classes.rb', line 1553 def response @response end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1560 1561 1562 1563 1564 1565 1566 |
# File 'generated/google/apis/dataproc_v1/classes.rb', line 1560 def update!(**args) @done = args[:done] if args.key?(:done) @error = args[:error] if args.key?(:error) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @response = args[:response] if args.key?(:response) end |