BeyondCorp AppGateways V1 API - Class Google::Cloud::BeyondCorp::AppGateways::V1::AppGatewaysService::Client (v0.1.0)

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

Client for the AppGatewaysService service.

API Overview

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

Data Model

The AppGatewaysService exposes the following resources:

  • AppGateways, named as follows: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}.

The AppGatewaysService service provides methods to manage (create/read/update/delete) BeyondCorp AppGateways.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the AppGatewaysService 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 AppGatewaysService clients
::Google::Cloud::BeyondCorp::AppGateways::V1::AppGatewaysService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the AppGatewaysService 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_app_gateway

def create_app_gateway(request, options = nil) -> ::Gapic::Operation
def create_app_gateway(parent: nil, app_gateway_id: nil, app_gateway: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new AppGateway in a given project and location.

Overloads 
def create_app_gateway(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_app_gateway via a request object, either of type CreateAppGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BeyondCorp::AppGateways::V1::CreateAppGatewayRequest, ::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 create_app_gateway(parent: nil, app_gateway_id: nil, app_gateway: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_app_gateway 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. The resource project name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}
  • app_gateway_id (::String) —

    Optional. User-settable AppGateway 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.
  • app_gateway (::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway, ::Hash) — Required. A BeyondCorp AppGateway 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 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/app_gateways/v1"

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

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

# Call the create_app_gateway method.
result = client.create_app_gateway 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_app_gateway

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

Deletes a single AppGateway.

Overloads 
def delete_app_gateway(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_app_gateway via a request object, either of type DeleteAppGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BeyondCorp::AppGateways::V1::DeleteAppGatewayRequest, ::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_app_gateway(name: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to delete_app_gateway 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. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
  • 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/app_gateways/v1"

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

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

# Call the delete_app_gateway method.
result = client.delete_app_gateway 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_app_gateway

def get_app_gateway(request, options = nil) -> ::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway
def get_app_gateway(name: nil) -> ::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway

Gets details of a single AppGateway.

Overloads 
def get_app_gateway(request, options = nil) -> ::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway
Pass arguments to get_app_gateway via a request object, either of type GetAppGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BeyondCorp::AppGateways::V1::GetAppGatewayRequest, ::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_app_gateway(name: nil) -> ::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway
Pass arguments to get_app_gateway 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. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
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/app_gateways/v1"

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

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

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

# The returned object is of type Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway.
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 AppGatewaysService client object.

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

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

#list_app_gateways

def list_app_gateways(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway>
def list_app_gateways(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway>

Lists AppGateways in a given project and location.

Overloads 
def list_app_gateways(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway>
Pass arguments to list_app_gateways via a request object, either of type ListAppGatewaysRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::BeyondCorp::AppGateways::V1::ListAppGatewaysRequest, ::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_app_gateways(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway>
Pass arguments to list_app_gateways 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. The resource name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}
  • page_size (::Integer) — Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's [next_page_token][BeyondCorp.ListAppGatewaysResponse.next_page_token] to determine if there are more instances left to be queried.
  • page_token (::String) — Optional. The next_page_token value returned from a previous ListAppGatewaysRequest, if any.
  • filter (::String) — Optional. A filter specifying constraints of a list operation.
  • order_by (::String) — Optional. Specifies the ordering of results. See Sorting order for more information.
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/app_gateways/v1"

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

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

# Call the list_app_gateways method.
result = client.list_app_gateways 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::AppGateways::V1::AppGateway.
  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::AppGateways::V1::AppGatewaysService::Operations

Get the associated client for long-running operations.

Returns