http4s-grpc-google-common-protos
2.18.0+0.0.5
API
Generated with
http4s-grpc-google-common-protos/com.google.longrunning.operations

com.google.longrunning.operations

package com.google.longrunning.operations

Members list

Concise view

Type members

Classlikes

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].

Attributes

name

The name of the operation resource to be cancelled.

Companion:
object
Source:
CancelOperationRequest.scala
Graph
Supertypes
trait Updatable[CancelOperationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CancelOperationRequest extends GeneratedMessageCompanion[CancelOperationRequest]

Attributes

Companion:
class
Source:
CancelOperationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CancelOperationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
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].

Attributes

name

The name of the operation resource to be deleted.

Companion:
object
Source:
DeleteOperationRequest.scala
Graph
Supertypes
trait Updatable[DeleteOperationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DeleteOperationRequest extends GeneratedMessageCompanion[DeleteOperationRequest]

Attributes

Companion:
class
Source:
DeleteOperationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteOperationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
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].

Attributes

name

The name of the operation resource.

Companion:
object
Source:
GetOperationRequest.scala
Graph
Supertypes
trait Updatable[GetOperationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetOperationRequest extends GeneratedMessageCompanion[GetOperationRequest]

Attributes

Companion:
class
Source:
GetOperationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetOperationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
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].

Attributes

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
Source:
ListOperationsRequest.scala
Graph
Supertypes
trait Updatable[ListOperationsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListOperationsRequest extends GeneratedMessageCompanion[ListOperationsRequest]

Attributes

Companion:
class
Source:
ListOperationsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListOperationsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
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].

Attributes

nextPageToken

The standard List next-page token.

operations

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

Companion:
object
Source:
ListOperationsResponse.scala
Graph
Supertypes
trait Updatable[ListOperationsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListOperationsResponse extends GeneratedMessageCompanion[ListOperationsResponse]

Attributes

Companion:
class
Source:
ListOperationsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListOperationsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
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.

Attributes

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
Source:
Operation.scala
Graph
Supertypes
trait Updatable[Operation]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Operation extends GeneratedMessageCompanion[Operation]

Attributes

Companion:
class
Source:
Operation.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Operation]
trait Serializable
class Object
trait Matchable
class Any
Self type
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" }; }

Attributes

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
Source:
OperationInfo.scala
Graph
Supertypes
trait Updatable[OperationInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object OperationInfo extends GeneratedMessageCompanion[OperationInfo]

Attributes

Companion:
class
Source:
OperationInfo.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[OperationInfo]
trait Serializable
class Object
trait Matchable
class Any
Self type
trait Operations[F[_]]

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.

Attributes

Companion:
object
Source:
Operations.scala
Graph
Supertypes
class Object
trait Matchable
class Any
object Operations

Attributes

Companion:
trait
Source:
Operations.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object OperationsProto extends GeneratedFileObject

Attributes

Source:
OperationsProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
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].

Attributes

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
Source:
WaitOperationRequest.scala
Graph
Supertypes
trait Updatable[WaitOperationRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object WaitOperationRequest extends GeneratedMessageCompanion[WaitOperationRequest]

Attributes

Companion:
class
Source:
WaitOperationRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[WaitOperationRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
Generated with