Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::VpnGateways::Rest::ServiceStub (v2.13.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::VpnGateways::Rest::ServiceStub.

REST service stub for the VpnGateways service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

Object

Methods

#aggregated_list

def aggregated_list(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Compute::V1::VpnGatewayAggregatedList

Baseline implementation for the aggregated_list REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::AggregatedListVpnGatewaysRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::VpnGatewayAggregatedList)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::VpnGatewayAggregatedList) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete

def delete(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the delete REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::DeleteVpnGatewayRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#get

def get(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Compute::V1::VpnGateway

Baseline implementation for the get REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::GetVpnGatewayRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::VpnGateway)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::VpnGateway) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_status

def get_status(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse

Baseline implementation for the get_status REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::GetStatusVpnGatewayRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#insert

def insert(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the insert REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::InsertVpnGatewayRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#list

def list(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Compute::V1::VpnGatewayList

Baseline implementation for the list REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::ListVpnGatewaysRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::VpnGatewayList)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::VpnGatewayList) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#set_labels

def set_labels(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the set_labels REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::SetLabelsVpnGatewayRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#test_iam_permissions

def test_iam_permissions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

Baseline implementation for the test_iam_permissions REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::TestIamPermissionsVpnGatewayRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::TestPermissionsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)