GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation
Table of Contents ▼
Jump to a specific part of the page:
Description
This resource represents a long-running operation that is the result of a network API call.
Attributes List
This module has the following attributes (case-insensitive ascending order):
Attributes
-
done
(type:boolean()
, default:nil
)
- If the value isfalse
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available. -
error
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleRpcStatus
, default:nil
)
- The error result of the operation in case of failure or cancellation. -
metadata
(type:map()
, default:nil
)
- 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. -
name
(type:String.t
, default:nil
)
- The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, thename
should be a resource name ending withoperations/{unique_id}
. -
response
(type:map()
, default:nil
)
- The normal, successful response of the operation. If the original method returns no data on success, such asDelete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
Type
@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation{
done: boolean() | nil,
error: GoogleApi.ContentWarehouse.V1.Model.GoogleRpcStatus.t() | nil,
metadata: map() | nil,
name: String.t() | nil,
response: map() | nil
}
done: boolean() | nil,
error: GoogleApi.ContentWarehouse.V1.Model.GoogleRpcStatus.t() | nil,
metadata: map() | nil,
name: String.t() | nil,
response: map() | nil
}
Function
@spec decode(struct(), keyword()) :: struct()Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.GoogleLongrunningOperation