proto-google-common-protos-scalapb_0.11/com.google.longrunning.operations

com.google.longrunning.operations

package com.google.longrunning.operations

Type members

Classlikes

@SerialVersionUID(0L)
final case
class CancelOperationRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CancelOperationRequest]

The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].

The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].

Value Params
name

The name of the operation resource to be cancelled.

Companion
object
object CancelOperationRequest extends GeneratedMessageCompanion[CancelOperationRequest] with JavaProtoSupport[CancelOperationRequest, CancelOperationRequest]
Companion
class
@SerialVersionUID(0L)
final case
class DeleteOperationRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DeleteOperationRequest]

The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].

The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].

Value Params
name

The name of the operation resource to be deleted.

Companion
object
object DeleteOperationRequest extends GeneratedMessageCompanion[DeleteOperationRequest] with JavaProtoSupport[DeleteOperationRequest, DeleteOperationRequest]
Companion
class
@SerialVersionUID(0L)
final case
class GetOperationRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetOperationRequest]

The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].

The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].

Value Params
name

The name of the operation resource.

Companion
object
object GetOperationRequest extends GeneratedMessageCompanion[GetOperationRequest] with JavaProtoSupport[GetOperationRequest, GetOperationRequest]
Companion
class
@SerialVersionUID(0L)
final case
class ListOperationsRequest(name: String, filter: String, pageSize: Int, pageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListOperationsRequest]

The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

Value Params
filter

The standard list filter.

name

The name of the operation's parent resource.

pageSize

The standard list page size.

pageToken

The standard list page token.

Companion
object
object ListOperationsRequest extends GeneratedMessageCompanion[ListOperationsRequest] with JavaProtoSupport[ListOperationsRequest, ListOperationsRequest]
Companion
class
@SerialVersionUID(0L)
final case
class ListOperationsResponse(operations: Seq[Operation], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListOperationsResponse]

The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

Value Params
nextPageToken

The standard List next-page token.

operations

A list of operations that matches the specified filter in the request.

Companion
object
object ListOperationsResponse extends GeneratedMessageCompanion[ListOperationsResponse] with JavaProtoSupport[ListOperationsResponse, ListOperationsResponse]
Companion
class
@SerialVersionUID(0L)
final case
class Operation(name: String, metadata: Option[Any], done: Boolean, result: Result, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Operation]

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.

Value Params
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.

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.

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 be a resource name ending with operations/{unique_id}.

Companion
object
object Operation extends GeneratedMessageCompanion[Operation] with JavaProtoSupport[Operation, Operation]
Companion
class
@SerialVersionUID(0L)
final case
class OperationInfo(responseType: String, metadataType: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[OperationInfo]

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" }; }

Value Params
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.

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.

Companion
object
object OperationInfo extends GeneratedMessageCompanion[OperationInfo] with JavaProtoSupport[OperationInfo, OperationInfo]
Companion
class
object OperationsProto extends GeneratedFileObject
@SerialVersionUID(0L)
final case
class WaitOperationRequest(name: String, timeout: Option[Duration], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[WaitOperationRequest]

The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].

The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].

Value Params
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.

Companion
object
object WaitOperationRequest extends GeneratedMessageCompanion[WaitOperationRequest] with JavaProtoSupport[WaitOperationRequest, WaitOperationRequest]
Companion
class