Class Google::Cloud::Compute::V1::VpnGateways::Rest::Client (v1.0.0)

REST client for the VpnGateways service.

The VpnGateways API.

Inherits

  • Object

Methods

.configure

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

Configure the VpnGateways Client class.

See Configuration for a description of the configuration fields.

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

#aggregated_list

def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::VpnGatewaysScopedList>
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::VpnGatewaysScopedList>

Retrieves an aggregated list of VPN gateways.

Overloads
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::VpnGatewaysScopedList>
Pass arguments to aggregated_list via a request object, either of type AggregatedListVpnGatewaysRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::AggregatedListVpnGatewaysRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::VpnGatewaysScopedList>
Pass arguments to aggregated_list 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
  • filter (::String) — A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
  • include_all_scopes (::Boolean) — Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
  • max_results (::Integer) — The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
  • order_by (::String) — Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
  • page_token (::String) — Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  • project (::String) — Project ID for this request.
  • return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::VpnGatewaysScopedList>)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::VpnGatewaysScopedList>)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#configure

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

Configure the VpnGateways 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

#delete

def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
def delete(project: nil, region: nil, request_id: nil, vpn_gateway: nil) -> ::Gapic::Rest::BaseOperation

Deletes the specified VPN gateway.

Overloads
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to delete via a request object, either of type DeleteVpnGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::DeleteVpnGatewayRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def delete(project: nil, region: nil, request_id: nil, vpn_gateway: nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to delete 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
  • project (::String) — Project ID for this request.
  • region (::String) — Name of the region for this request.
  • request_id (::String) — 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. For example, consider a situation where you make an initial request and the 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).
  • vpn_gateway (::String) — Name of the VPN gateway to delete.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::VpnGateway
def get(project: nil, region: nil, vpn_gateway: nil) -> ::Google::Cloud::Compute::V1::VpnGateway

Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

Overloads
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::VpnGateway
Pass arguments to get via a request object, either of type GetVpnGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetVpnGatewayRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get(project: nil, region: nil, vpn_gateway: nil) -> ::Google::Cloud::Compute::V1::VpnGateway
Pass arguments to get 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
  • project (::String) — Project ID for this request.
  • region (::String) — Name of the region for this request.
  • vpn_gateway (::String) — Name of the VPN gateway to return.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_status

def get_status(request, options = nil) -> ::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse
def get_status(project: nil, region: nil, vpn_gateway: nil) -> ::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse

Returns the status for the specified VPN gateway.

Overloads
def get_status(request, options = nil) -> ::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse
Pass arguments to get_status via a request object, either of type GetStatusVpnGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetStatusVpnGatewayRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get_status(project: nil, region: nil, vpn_gateway: nil) -> ::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse
Pass arguments to get_status 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
  • project (::String) — Project ID for this request.
  • region (::String) — Name of the region for this request.
  • vpn_gateway (::String) — Name of the VPN gateway to return.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#initialize

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

Create a new VpnGateways REST client object.

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

# Create a client using a custom configuration
client = ::Google::Cloud::Compute::V1::VpnGateways::Rest::Client.new do |config|
  config.timeout = 10.0
end

#insert

def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
def insert(project: nil, region: nil, request_id: nil, vpn_gateway_resource: nil) -> ::Gapic::Rest::BaseOperation

Creates a VPN gateway in the specified project and region using the data included in the request.

Overloads
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to insert via a request object, either of type InsertVpnGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::InsertVpnGatewayRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def insert(project: nil, region: nil, request_id: nil, vpn_gateway_resource: nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to insert 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
  • project (::String) — Project ID for this request.
  • region (::String) — Name of the region for this request.
  • request_id (::String) — 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. For example, consider a situation where you make an initial request and the 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).
  • vpn_gateway_resource (::Google::Cloud::Compute::V1::VpnGateway, ::Hash) — The body resource for this request
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list

def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::VpnGateway>
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::VpnGateway>

Retrieves a list of VPN gateways available to the specified project and region.

Overloads
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::VpnGateway>
Pass arguments to list via a request object, either of type ListVpnGatewaysRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::ListVpnGatewaysRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::VpnGateway>
Pass arguments to list 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
  • filter (::String) — A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
  • max_results (::Integer) — The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
  • order_by (::String) — Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
  • page_token (::String) — Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  • project (::String) — Project ID for this request.
  • region (::String) — Name of the region for this request.
  • return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#set_labels

def set_labels(request, options = nil) -> ::Gapic::Rest::BaseOperation
def set_labels(project: nil, region: nil, region_set_labels_request_resource: nil, request_id: nil, resource: nil) -> ::Gapic::Rest::BaseOperation

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

Overloads
def set_labels(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to set_labels via a request object, either of type SetLabelsVpnGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::SetLabelsVpnGatewayRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_labels(project: nil, region: nil, region_set_labels_request_resource: nil, request_id: nil, resource: nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to set_labels 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
  • project (::String) — Project ID for this request.
  • region (::String) — The region for this request.
  • region_set_labels_request_resource (::Google::Cloud::Compute::V1::RegionSetLabelsRequest, ::Hash) — The body resource for this request
  • request_id (::String) — 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. For example, consider a situation where you make an initial request and the 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).
  • resource (::String) — Name or id of the resource for this request.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
def test_iam_permissions(project: nil, region: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

Returns permissions that a caller has on the specified resource.

Overloads
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
Pass arguments to test_iam_permissions via a request object, either of type TestIamPermissionsVpnGatewayRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::TestIamPermissionsVpnGatewayRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def test_iam_permissions(project: nil, region: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
Pass arguments to test_iam_permissions 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
  • project (::String) — Project ID for this request.
  • region (::String) — The name of the region for this request.
  • resource (::String) — Name or id of the resource for this request.
  • test_permissions_request_resource (::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash) — The body resource for this request
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.