# Secure Source Manager V1 API - Class Google::Cloud::SecureSourceManager::V1::SecureSourceManager::Rest::Operations (v2.7.0) 2.7.0 (latest) 2.6.1 2.5.0 2.4.0 2.3.0 2.2.1 2.1.0 2.0.1 1.3.0 1.2.0 1.1.0 1.0.1 0.4.0 0.3.0 0.2.2 0.1.0 Reference documentation and code samples for the Secure Source Manager V1 API class Google::Cloud::SecureSourceManager::V1::SecureSourceManager::Rest::Operations. Service that implements Longrunning Operations API. ## Inherits - Object ## Methods ### .configure def self.configure() { |config| ... } -> Operations::Configuration Configuration for the SecureSourceManager Operations API. **Yields** - (config) --- Configure the Operations client. **Yield Parameter** - **config** ([Operations::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Cloud-SecureSourceManager-V1-SecureSourceManager-Rest-Operations-Configuration)) **Returns** - ([Operations::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Cloud-SecureSourceManager-V1-SecureSourceManager-Rest-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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_error_instance_ "Google::Longrunning::Operation#error (method)") value with a [google.rpc.Status.code](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Rpc-Status#Google__Rpc__Status_code_instance_ "Google::Rpc::Status#code (method)") of `1`, corresponding to `Code.CANCELLED`. **Overloads** def cancel_operation(request, options = nil) -> ::Google::Protobuf::Empty Pass arguments to `cancel_operation` via a request object, either of type [Longrunning::CancelOperationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Longrunning-CancelOperationRequest "Google::Longrunning::CancelOperationRequest (class)") or an equivalent Hash. **Parameters** - **request** ([::Google::Longrunning::CancelOperationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/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 Pass arguments to `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). **Parameter** - **name** (::String) --- The name of the operation resource to be cancelled. **Yields** - (result, operation) --- Access the result along with the TransportOperation object **Yield Parameters** - **result** ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Protobuf-Empty)) - **operation** (::Gapic::Rest::TransportOperation) **Returns** - ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Protobuf-Empty)) **Raises** - (::Google::Cloud::Error) --- if the REST call is aborted. **Example** Basic example ```ruby 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 SecureSourceManager 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Cloud-SecureSourceManager-V1-SecureSourceManager-Rest-Operations#Google__Cloud__SecureSourceManager__V1__SecureSourceManager__Rest__Operations_configure_class_ "Google::Cloud::SecureSourceManager::V1::SecureSourceManager::Rest::Operations.configure (method)"). **Yields** - (config) --- Configure the Operations client. **Yield Parameter** - **config** ([Operations::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Cloud-SecureSourceManager-V1-SecureSourceManager-Rest-Operations-Configuration)) **Returns** - ([Operations::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Cloud-SecureSourceManager-V1-SecureSourceManager-Rest-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`. **Overloads** def delete_operation(request, options = nil) -> ::Google::Protobuf::Empty Pass arguments to `delete_operation` via a request object, either of type [Longrunning::DeleteOperationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Longrunning-DeleteOperationRequest "Google::Longrunning::DeleteOperationRequest (class)") or an equivalent Hash. **Parameters** - **request** ([::Google::Longrunning::DeleteOperationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/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 Pass arguments to `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). **Parameter** - **name** (::String) --- The name of the operation resource to be deleted. **Yields** - (result, operation) --- Access the result along with the TransportOperation object **Yield Parameters** - **result** ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Protobuf-Empty)) - **operation** (::Gapic::Rest::TransportOperation) **Returns** - ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Protobuf-Empty)) **Raises** - (::Google::Cloud::Error) --- if the REST call is aborted. **Example** Basic example ```ruby 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. **Overloads** def get_operation(request, options = nil) -> ::Gapic::Operation Pass arguments to `get_operation` via a request object, either of type [Longrunning::GetOperationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Longrunning-GetOperationRequest "Google::Longrunning::GetOperationRequest (class)") or an equivalent Hash. **Parameters** - **request** ([::Google::Longrunning::GetOperationRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/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 Pass arguments to `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). **Parameter** - **name** (::String) --- The name of the operation resource. **Yields** - (result, operation) --- Access the result along with the TransportOperation object **Yield Parameters** - **result** (::Gapic::Operation) - **operation** (::Gapic::Rest::TransportOperation) **Returns** - (::Gapic::Operation) **Raises** - (::Google::Cloud::Error) --- if the REST call is aborted. **Example** Basic example ```ruby 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. **Yields** - (config) --- Configure the Client client. **Yield Parameter** - **config** ([Operations::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Cloud-SecureSourceManager-V1-SecureSourceManager-Rest-Operations-Configuration)) **Returns** - ([Operations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Cloud-SecureSourceManager-V1-SecureSourceManager-Rest-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, return_partial_success: nil) -> ::Gapic::Operation Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. **Overloads** def list_operations(request, options = nil) -> ::Gapic::Operation Pass arguments to `list_operations` via a request object, either of type [Longrunning::ListOperationsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/Google-Longrunning-ListOperationsRequest "Google::Longrunning::ListOperationsRequest (class)") or an equivalent Hash. **Parameters** - **request** ([::Google::Longrunning::ListOperationsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-secure_source_manager-v1/latest/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, return_partial_success: nil) -> ::Gapic::Operation Pass arguments to `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). **Parameters** - **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. - **return_partial_success** (::Boolean) --- When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the \[ListOperationsResponse.unreachable\] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. **Yields** - (result, operation) --- Access the result along with the TransportOperation object **Yield Parameters** - **result** (::Gapic::Operation) - **operation** (::Gapic::Rest::TransportOperation) **Returns** - (::Gapic::Operation) **Raises** - (::Google::Cloud::Error) --- if the REST call is aborted. **Example** Basic example ```ruby 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 **Returns** - (String)