# Copyright 2018 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. module Google module Longrunning # This resource represents a long-running operation that is the result of a # network API call. # @!attribute [rw] name # @return [String] # 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 of +operations/some/unique/name+. # @!attribute [rw] metadata # @return [Google::Protobuf::Any] # 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. # @!attribute [rw] done # @return [true, false] # 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. # @!attribute [rw] error # @return [Google::Rpc::Status] # The error result of the operation in case of failure or cancellation. # @!attribute [rw] response # @return [Google::Protobuf::Any] # The normal response of the operation in case of success. If the original # method returns no data on success, such as +Delete+, the response is # +google.protobuf.Empty+. If the original method is standard # +Get+/+Create+/+Update+, the response should be the resource. For other # methods, the response should have the type +XxxResponse+, where +Xxx+ # is the original method name. For example, if the original method name # is +TakeSnapshot()+, the inferred response type is # +TakeSnapshotResponse+. class Operation; end # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}. # @!attribute [rw] name # @return [String] # The name of the operation resource. class GetOperationRequest; end # The request message for {Google::Longrunning::Operations::ListOperations Operations::ListOperations}. # @!attribute [rw] name # @return [String] # The name of the operation collection. # @!attribute [rw] filter # @return [String] # The standard list filter. # @!attribute [rw] page_size # @return [Integer] # The standard list page size. # @!attribute [rw] page_token # @return [String] # The standard list page token. class ListOperationsRequest; end # The response message for {Google::Longrunning::Operations::ListOperations Operations::ListOperations}. # @!attribute [rw] operations # @return [Array] # A list of operations that matches the specified filter in the request. # @!attribute [rw] next_page_token # @return [String] # The standard List next-page token. class ListOperationsResponse; end # The request message for {Google::Longrunning::Operations::CancelOperation Operations::CancelOperation}. # @!attribute [rw] name # @return [String] # The name of the operation resource to be cancelled. class CancelOperationRequest; end # The request message for {Google::Longrunning::Operations::DeleteOperation Operations::DeleteOperation}. # @!attribute [rw] name # @return [String] # The name of the operation resource to be deleted. class DeleteOperationRequest; end end end