package longrunning
- Alphabetic
- Public
- All
Type Members
-
final
case class
CancelOperationRequest(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CancelOperationRequest] with Product with Serializable
The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
- name
The name of the operation resource to be cancelled.
- Annotations
- @SerialVersionUID()
- final class DefaultOperationsClient extends OperationsClient
-
final
case class
DeleteOperationRequest(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DeleteOperationRequest] with Product with Serializable
The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
- name
The name of the operation resource to be deleted.
- Annotations
- @SerialVersionUID()
-
final
case class
GetOperationRequest(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetOperationRequest] with Product with Serializable
The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
- name
The name of the operation resource.
- Annotations
- @SerialVersionUID()
-
final
case class
ListOperationsRequest(name: String = "", filter: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListOperationsRequest] with Product with Serializable
The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
- name
The name of the operation's parent resource.
- filter
The standard list filter.
- pageSize
The standard list page size.
- pageToken
The standard list page token.
- Annotations
- @SerialVersionUID()
-
final
case class
ListOperationsResponse(operations: Seq[Operation] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListOperationsResponse] with Product with Serializable
The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
- operations
A list of operations that matches the specified filter in the request.
- nextPageToken
The standard List next-page token.
- Annotations
- @SerialVersionUID()
-
final
case class
Operation(name: String = "", metadata: Option[Any] = _root_.scala.None, done: Boolean = false, result: Result = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Operation] with Product with Serializable
This resource represents a long-running operation that is the result of a network API call.
This resource represents a long-running operation that is the result of a network API call.
- name
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 ofoperations/some/unique/name
.- metadata
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.
- done
If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.
- Annotations
- @SerialVersionUID()
-
final
case class
OperationInfo(responseType: String = "", metadataType: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[OperationInfo] with Product with Serializable
A message representing the message types used by a long-running operation.
A message representing the message types used by a long-running operation.
Example:
rpc LongRunningRecognize(LongRunningRecognizeRequest) returns (google.longrunning.Operation) { option (google.longrunning.operation_info) = { response_type: "LongRunningRecognizeResponse" metadata_type: "LongRunningRecognizeMetadata" }; }
- responseType
Required. The message name of the primary return type for this long-running operation. This type will be used to deserialize the LRO's response. If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g.
google.protobuf.Struct
). Note: Altering this value constitutes a breaking change.- metadataType
Required. The message name of the metadata type for this long-running operation. If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g.
google.protobuf.Struct
). Note: Altering this value constitutes a breaking change.
- Annotations
- @SerialVersionUID()
-
trait
Operations extends AnyRef
Manages long-running operations with an API service.
Manages long-running operations with an API service. When an API method normally takes long time to complete, it can be designed to return [Operation][google.longrunning.Operation] to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Google Cloud Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement the
Operations
interface so developers can have a consistent client experience. - trait OperationsClient extends Operations with OperationsClientPowerApi with AkkaGrpcClient
- trait OperationsClientPowerApi extends AnyRef
-
final
case class
WaitOperationRequest(name: String = "", timeout: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[WaitOperationRequest] with Product with Serializable
The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].
The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].
- name
The name of the operation resource to wait on.
- timeout
The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
- Annotations
- @SerialVersionUID()
Value Members
- object CancelOperationRequest extends GeneratedMessageCompanion[CancelOperationRequest] with Serializable
- object DeleteOperationRequest extends GeneratedMessageCompanion[DeleteOperationRequest] with Serializable
- object GetOperationRequest extends GeneratedMessageCompanion[GetOperationRequest] with Serializable
- object ListOperationsRequest extends GeneratedMessageCompanion[ListOperationsRequest] with Serializable
- object ListOperationsResponse extends GeneratedMessageCompanion[ListOperationsResponse] with Serializable
- object Operation extends GeneratedMessageCompanion[Operation] with Serializable
- object OperationInfo extends GeneratedMessageCompanion[OperationInfo] with Serializable
- object Operations extends ServiceDescription
- object OperationsClient
- object OperationsHandler
- object OperationsProto extends GeneratedFileObject
- object WaitOperationRequest extends GeneratedMessageCompanion[WaitOperationRequest] with Serializable