com.google.longrunning.operations.Operations.scala Maven / Gradle / Ivy

Go to download

// Generated by Pekko gRPC. DO NOT EDIT.
package com.google.longrunning.operations

import org.apache.pekko
import pekko.annotation.ApiMayChange

import pekko.grpc.PekkoGrpcGenerated

/**
 * 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.
 */
@PekkoGrpcGenerated
trait Operations {
  
  /**
   * Lists operations that match the specified filter in the request. If the
   * server doesn't support this method, it returns `UNIMPLEMENTED`.
   *  NOTE: the `name` binding allows API services to override the binding
   * to use different resource name schemes, such as `users/*/operations`. To
   * override the binding, API services can add a binding such as
   * `"/v1/{name=users/*}/operations"` to their service configuration.
   * For backwards compatibility, the default name includes the operations
   * collection id, however overriding users must ensure the name binding
   * is the parent resource, without the operations collection id.
   */
  def listOperations(in: com.google.longrunning.operations.ListOperationsRequest): scala.concurrent.Future[com.google.longrunning.operations.ListOperationsResponse]
  
  /**
   * Gets the latest state of a long-running operation.  Clients can use this
   * method to poll the operation result at intervals as recommended by the API
   * service.
   */
  def getOperation(in: com.google.longrunning.operations.GetOperationRequest): scala.concurrent.Future[com.google.longrunning.operations.Operation]
  
  /**
   * Deletes a long-running operation. This method indicates that the client is
   * no longer interested in the operation result. It does not cancel the
   * operation. If the server doesn't support this method, it returns
   * `google.rpc.Code.UNIMPLEMENTED`.
   */
  def deleteOperation(in: com.google.longrunning.operations.DeleteOperationRequest): scala.concurrent.Future[com.google.protobuf.empty.Empty]
  
  /**
   * Starts asynchronous cancellation on a long-running operation.  The server
   * makes a best effort to cancel the operation, but success is not
   * guaranteed.  If the server doesn't support this method, it returns
   * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
   * [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
   * other methods to check whether the cancellation succeeded or whether the
   * operation completed despite cancellation. On successful cancellation,
   * the operation is not deleted; instead, it becomes an operation with
   * an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
   * corresponding to `Code.CANCELLED`.
   */
  def cancelOperation(in: com.google.longrunning.operations.CancelOperationRequest): scala.concurrent.Future[com.google.protobuf.empty.Empty]
  
  /**
   * Waits until the specified long-running operation is done or reaches at most
   * a specified timeout, returning the latest state.  If the operation is
   * already done, the latest state is immediately returned.  If the timeout
   * specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
   * timeout is used.  If the server does not support this method, it returns
   * `google.rpc.Code.UNIMPLEMENTED`.
   * Note that this method is on a best-effort basis.  It may return the latest
   * state before the specified timeout (including immediately), meaning even an
   * immediate response is no guarantee that the operation is done.
   */
  def waitOperation(in: com.google.longrunning.operations.WaitOperationRequest): scala.concurrent.Future[com.google.longrunning.operations.Operation]
  
}



@PekkoGrpcGenerated
object Operations extends pekko.grpc.ServiceDescription {
  val name = "google.longrunning.Operations"

  val descriptor: com.google.protobuf.Descriptors.FileDescriptor =
    com.google.longrunning.operations.OperationsProto.javaDescriptor;

  object Serializers {
    import pekko.grpc.scaladsl.ScalapbProtobufSerializer
    
    val ListOperationsRequestSerializer = new ScalapbProtobufSerializer(com.google.longrunning.operations.ListOperationsRequest.messageCompanion)
    
    val GetOperationRequestSerializer = new ScalapbProtobufSerializer(com.google.longrunning.operations.GetOperationRequest.messageCompanion)
    
    val DeleteOperationRequestSerializer = new ScalapbProtobufSerializer(com.google.longrunning.operations.DeleteOperationRequest.messageCompanion)
    
    val CancelOperationRequestSerializer = new ScalapbProtobufSerializer(com.google.longrunning.operations.CancelOperationRequest.messageCompanion)
    
    val WaitOperationRequestSerializer = new ScalapbProtobufSerializer(com.google.longrunning.operations.WaitOperationRequest.messageCompanion)
    
    val ListOperationsResponseSerializer = new ScalapbProtobufSerializer(com.google.longrunning.operations.ListOperationsResponse.messageCompanion)
    
    val OperationSerializer = new ScalapbProtobufSerializer(com.google.longrunning.operations.Operation.messageCompanion)
    
    val google_protobuf_EmptySerializer = new ScalapbProtobufSerializer(com.google.protobuf.empty.Empty.messageCompanion)
    
  }

  @ApiMayChange
  @PekkoGrpcGenerated
  object MethodDescriptors {
    import pekko.grpc.internal.Marshaller
    import io.grpc.MethodDescriptor
    import Serializers._

    
    val listOperationsDescriptor: MethodDescriptor[com.google.longrunning.operations.ListOperationsRequest, com.google.longrunning.operations.ListOperationsResponse] =
      MethodDescriptor.newBuilder()
        .setType(
   MethodDescriptor.MethodType.UNARY 
  
  
  
)
        .setFullMethodName(MethodDescriptor.generateFullMethodName("google.longrunning.Operations", "ListOperations"))
        .setRequestMarshaller(new Marshaller(ListOperationsRequestSerializer))
        .setResponseMarshaller(new Marshaller(ListOperationsResponseSerializer))
        .setSampledToLocalTracing(true)
        .build()
    
    val getOperationDescriptor: MethodDescriptor[com.google.longrunning.operations.GetOperationRequest, com.google.longrunning.operations.Operation] =
      MethodDescriptor.newBuilder()
        .setType(
   MethodDescriptor.MethodType.UNARY 
  
  
  
)
        .setFullMethodName(MethodDescriptor.generateFullMethodName("google.longrunning.Operations", "GetOperation"))
        .setRequestMarshaller(new Marshaller(GetOperationRequestSerializer))
        .setResponseMarshaller(new Marshaller(OperationSerializer))
        .setSampledToLocalTracing(true)
        .build()
    
    val deleteOperationDescriptor: MethodDescriptor[com.google.longrunning.operations.DeleteOperationRequest, com.google.protobuf.empty.Empty] =
      MethodDescriptor.newBuilder()
        .setType(
   MethodDescriptor.MethodType.UNARY 
  
  
  
)
        .setFullMethodName(MethodDescriptor.generateFullMethodName("google.longrunning.Operations", "DeleteOperation"))
        .setRequestMarshaller(new Marshaller(DeleteOperationRequestSerializer))
        .setResponseMarshaller(new Marshaller(google_protobuf_EmptySerializer))
        .setSampledToLocalTracing(true)
        .build()
    
    val cancelOperationDescriptor: MethodDescriptor[com.google.longrunning.operations.CancelOperationRequest, com.google.protobuf.empty.Empty] =
      MethodDescriptor.newBuilder()
        .setType(
   MethodDescriptor.MethodType.UNARY 
  
  
  
)
        .setFullMethodName(MethodDescriptor.generateFullMethodName("google.longrunning.Operations", "CancelOperation"))
        .setRequestMarshaller(new Marshaller(CancelOperationRequestSerializer))
        .setResponseMarshaller(new Marshaller(google_protobuf_EmptySerializer))
        .setSampledToLocalTracing(true)
        .build()
    
    val waitOperationDescriptor: MethodDescriptor[com.google.longrunning.operations.WaitOperationRequest, com.google.longrunning.operations.Operation] =
      MethodDescriptor.newBuilder()
        .setType(
   MethodDescriptor.MethodType.UNARY 
  
  
  
)
        .setFullMethodName(MethodDescriptor.generateFullMethodName("google.longrunning.Operations", "WaitOperation"))
        .setRequestMarshaller(new Marshaller(WaitOperationRequestSerializer))
        .setResponseMarshaller(new Marshaller(OperationSerializer))
        .setSampledToLocalTracing(true)
        .build()
    
  }
}