BeyondCorp ClientConnectorServices V1 API - Class Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client (v0.1.1)

Reference documentation and code samples for the BeyondCorp ClientConnectorServices V1 API class Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.

Client for the ClientConnectorServicesService service.

API Overview

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

Data Model

The ClientConnectorServicesService exposes the following resources:

  • Client Connector Services, named as follows: projects/{project_id}/locations/{location_id}/client_connector_services/{client_connector_service_id}.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ClientConnectorServicesService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ClientConnectorServicesService clients
::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ClientConnectorServicesService Client 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_client_connector_service

def create_client_connector_service(request, options = nil) -> ::Gapic::Operation
def create_client_connector_service(parent: nil, client_connector_service_id: nil, client_connector_service: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new ClientConnectorService in a given project and location.

Overloads 
def create_client_connector_service(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_client_connector_service via a request object, either of type Google::Cloud::BeyondCorp::ClientConnectorServices::V1::CreateClientConnectorServiceRequest or an equivalent Hash.
Parameters 
def create_client_connector_service(parent: nil, client_connector_service_id: nil, client_connector_service: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_client_connector_service 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
  • parent (::String) — Required. Value for parent.
  • client_connector_service_id (::String) — Optional. User-settable client connector service resource ID.

    • Must start with a letter.
    • Must contain between 4-63 characters from /[a-z][0-9]-/.
    • Must end with a number or a letter.

    A random system generated name will be assigned if not specified by the user.

  • client_connector_service (::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • validate_only (::Boolean) — Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/beyond_corp/client_connector_services/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::CreateClientConnectorServiceRequest.new

# Call the create_client_connector_service method.
result = client.create_client_connector_service request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#delete_client_connector_service

def delete_client_connector_service(request, options = nil) -> ::Gapic::Operation
def delete_client_connector_service(name: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Deletes a single ClientConnectorService.

Overloads 
def delete_client_connector_service(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_client_connector_service via a request object, either of type DeleteClientConnectorServiceRequest or an equivalent Hash.
Parameters 
def delete_client_connector_service(name: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to delete_client_connector_service 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) — Required. Name of the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • validate_only (::Boolean) — Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/beyond_corp/client_connector_services/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::DeleteClientConnectorServiceRequest.new

# Call the delete_client_connector_service method.
result = client.delete_client_connector_service request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#get_client_connector_service

def get_client_connector_service(request, options = nil) -> ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService
def get_client_connector_service(name: nil) -> ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService

Gets details of a single ClientConnectorService.

Overloads 
def get_client_connector_service(request, options = nil) -> ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService
Pass arguments to get_client_connector_service via a request object, either of type GetClientConnectorServiceRequest or an equivalent Hash.
Parameters 
def get_client_connector_service(name: nil) -> ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService
Pass arguments to get_client_connector_service 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) — Required. Name of the resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/beyond_corp/client_connector_services/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::GetClientConnectorServiceRequest.new

# Call the get_client_connector_service method.
result = client.get_client_connector_service request

# The returned object is of type Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new ClientConnectorServicesService client object.

Yields
  • (config) — Configure the ClientConnectorServicesService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new do |config|
  config.timeout = 10.0
end

#list_client_connector_services

def list_client_connector_services(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService>
def list_client_connector_services(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService>

Lists ClientConnectorServices in a given project and location.

Overloads 
def list_client_connector_services(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService>
Pass arguments to list_client_connector_services via a request object, either of type ListClientConnectorServicesRequest or an equivalent Hash.
Parameters 
def list_client_connector_services(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService>
Pass arguments to list_client_connector_services 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
  • parent (::String) — Required. Parent value for ListClientConnectorServicesRequest.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results.
  • order_by (::String) — Optional. Hint for how to order the results.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/beyond_corp/client_connector_services/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ListClientConnectorServicesRequest.new

# Call the list_client_connector_services method.
result = client.list_client_connector_services request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService.
  p response
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#operations_client

def operations_client() -> ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Operations

Get the associated client for long-running operations.

Returns

#update_client_connector_service

def update_client_connector_service(request, options = nil) -> ::Gapic::Operation
def update_client_connector_service(update_mask: nil, client_connector_service: nil, request_id: nil, validate_only: nil, allow_missing: nil) -> ::Gapic::Operation

Updates the parameters of a single ClientConnectorService.

Overloads 
def update_client_connector_service(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_client_connector_service via a request object, either of type UpdateClientConnectorServiceRequest or an equivalent Hash.
Parameters 
def update_client_connector_service(update_mask: nil, client_connector_service: nil, request_id: nil, validate_only: nil, allow_missing: nil) -> ::Gapic::Operation
Pass arguments to update_client_connector_service 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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

    Mutable fields: display_name.

  • client_connector_service (::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService, ::Hash) — Required. The resource being updated.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • validate_only (::Boolean) — Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
  • allow_missing (::Boolean) — Optional. If set as true, will create the resource if it is not found.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/beyond_corp/client_connector_services/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::UpdateClientConnectorServiceRequest.new

# Call the update_client_connector_service method.
result = client.update_client_connector_service request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end