class Google::Cloud::Lustre::V1::Lustre::Rest::Operations
Service that implements Longrunning Operations API.
def self.configure
-
(Operations::Configuration)
-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Operations client.
def self.configure @configure ||= Operations::Configuration.new yield @configure if block_given? @configure end
def cancel_operation request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Google::Protobuf::Empty)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Longrunning::CancelOperationRequest, ::Hash
) --
Overloads:
-
cancel_operation(name: nil)
-
cancel_operation(request, options = nil)
def cancel_operation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::CancelOperationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.cancel_operation.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout, metadata: call_metadata, retry_policy: @config.rpcs.cancel_operation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @operations_stub.cancel_operation request, options do |result, operation| yield result, operation if block_given? end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def configure
-
(Operations::Configuration)
-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Operations client.
def configure yield @config if block_given? @config end
def delete_operation request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Google::Protobuf::Empty)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Longrunning::DeleteOperationRequest, ::Hash
) --
Overloads:
-
delete_operation(name: nil)
-
delete_operation(request, options = nil)
def delete_operation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::DeleteOperationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.delete_operation.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.delete_operation.timeout, metadata: call_metadata, retry_policy: @config.rpcs.delete_operation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @operations_stub.delete_operation request, options do |result, operation| yield result, operation if block_given? end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def get_operation request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Operation)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Longrunning::GetOperationRequest, ::Hash
) --
Overloads:
-
get_operation(name: nil)
-
get_operation(request, options = nil)
def get_operation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::GetOperationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_operation.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_operation.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_operation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @operations_stub.get_operation request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def initialize
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
def initialize # Create the configuration object @config = Configuration.new Operations.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_stub = OperationsServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) # Used by an LRO wrapper for some methods of this service @operations_client = self end
def list_operations request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)
- if the REST call is aborted.
Returns:
-
(::Gapic::Operation)
-
Other tags:
- Yieldparam: operation -
Yieldparam: result -
Other tags:
- Yield: - Access the result along with the TransportOperation object
Parameters:
-
page_token
(::String
) -- -
page_size
(::Integer
) -- -
filter
(::String
) -- -
name
(::String
) -- -
options
(::Gapic::CallOptions, ::Hash
) -- -
request
(::Google::Longrunning::ListOperationsRequest, ::Hash
) --
Overloads:
-
list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
-
list_operations(request, options = nil)
def list_operations request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::ListOperationsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_operations.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Lustre::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_operations.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_operations.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @operations_stub.list_operations request, options do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options yield result, operation if block_given? throw :response, result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end
def universe_domain
-
(String)
-
def universe_domain @operations_stub.universe_domain end