Reference documentation and code samples for the Cloud Video Intelligence V1p2beta1 API class Google::Cloud::VideoIntelligence::V1p2beta1::VideoIntelligenceService::Rest::Operations.
Service that implements Longrunning Operations API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Operations::Configuration
Configuration for the VideoIntelligenceService Operations API.
- (config) — Configure the Operations client.
- config (Operations::Configuration)
#cancel_operation
def cancel_operation(request, options = nil) -> ::Google::Protobuf::Empty
def cancel_operation(name: nil) -> ::Google::Protobuf::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 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 value with a
google.rpc.Status.code of 1
, corresponding to
Code.CANCELLED
.
def cancel_operation(request, options = nil) -> ::Google::Protobuf::Empty
cancel_operation
via a request object, either of type
Longrunning::CancelOperationRequest or an equivalent Hash.
- request (::Google::Longrunning::CancelOperationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def cancel_operation(name: nil) -> ::Google::Protobuf::Empty
cancel_operation
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — The name of the operation resource to be cancelled.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/longrunning" # Create a client object. The client can be reused for multiple calls. client = Google::Longrunning::Operations::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Longrunning::CancelOperationRequest.new # Call the cancel_operation method. result = client.cancel_operation request # The returned object is of type Google::Protobuf::Empty. p result
#configure
def configure() { |config| ... } -> Operations::Configuration
Configure the VideoIntelligenceService Operations instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Operations.configure.
- (config) — Configure the Operations client.
- config (Operations::Configuration)
#delete_operation
def delete_operation(request, options = nil) -> ::Google::Protobuf::Empty
def delete_operation(name: nil) -> ::Google::Protobuf::Empty
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 delete_operation(request, options = nil) -> ::Google::Protobuf::Empty
delete_operation
via a request object, either of type
Longrunning::DeleteOperationRequest or an equivalent Hash.
- request (::Google::Longrunning::DeleteOperationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_operation(name: nil) -> ::Google::Protobuf::Empty
delete_operation
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — The name of the operation resource to be deleted.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/longrunning" # Create a client object. The client can be reused for multiple calls. client = Google::Longrunning::Operations::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Longrunning::DeleteOperationRequest.new # Call the delete_operation method. result = client.delete_operation request # The returned object is of type Google::Protobuf::Empty. p result
#get_operation
def get_operation(request, options = nil) -> ::Gapic::Operation
def get_operation(name: nil) -> ::Gapic::Operation
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 get_operation(request, options = nil) -> ::Gapic::Operation
get_operation
via a request object, either of type
Longrunning::GetOperationRequest or an equivalent Hash.
- request (::Google::Longrunning::GetOperationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_operation(name: nil) -> ::Gapic::Operation
get_operation
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — The name of the operation resource.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/longrunning" # Create a client object. The client can be reused for multiple calls. client = Google::Longrunning::Operations::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Longrunning::GetOperationRequest.new # Call the get_operation method. result = client.get_operation request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#initialize
def initialize() { |config| ... } -> Operations
Create a new Operations client object.
- (config) — Configure the Client client.
- config (Operations::Configuration)
- (Operations) — a new instance of Operations
#list_operations
def list_operations(request, options = nil) -> ::Gapic::Operation
def list_operations(name: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Operation
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
def list_operations(request, options = nil) -> ::Gapic::Operation
list_operations
via a request object, either of type
Longrunning::ListOperationsRequest or an equivalent Hash.
- request (::Google::Longrunning::ListOperationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_operations(name: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Operation
list_operations
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — The name of the operation's parent resource.
- filter (::String) — The standard list filter.
- page_size (::Integer) — The standard list page size.
- page_token (::String) — The standard list page token.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/longrunning" # Create a client object. The client can be reused for multiple calls. client = Google::Longrunning::Operations::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Longrunning::ListOperationsRequest.new # Call the list_operations method. result = client.list_operations request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Longrunning::Operation. p item end
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)