Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::InstanceGroups::Rest::ServiceStub (v2.12.0)

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

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

Inherits

Object

Methods

#add_instances

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

Baseline implementation for the add_instances REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::AddInstancesInstanceGroupRequest) — 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)

#aggregated_list

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

Baseline implementation for the aggregated_list REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::AggregatedListInstanceGroupsRequest) — 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::InstanceGroupAggregatedList)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::InstanceGroupAggregatedList) — 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::DeleteInstanceGroupRequest) — 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::InstanceGroup

Baseline implementation for the get REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::GetInstanceGroupRequest) — 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::InstanceGroup)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::InstanceGroup) — 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::InsertInstanceGroupRequest) — 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::InstanceGroupList

Baseline implementation for the list REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::ListInstanceGroupsRequest) — 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::InstanceGroupList)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#list_instances

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

Baseline implementation for the list_instances REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::ListInstancesInstanceGroupsRequest) — 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::InstanceGroupsListInstances)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#remove_instances

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

Baseline implementation for the remove_instances REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::RemoveInstancesInstanceGroupRequest) — 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)

#set_named_ports

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

Baseline implementation for the set_named_ports REST call

Parameters

request_pb (::Google::Cloud::Compute::V1::SetNamedPortsInstanceGroupRequest) — 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)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)