class Google::Cloud::Compute::V1::InstanceGroups::Rest::Client

REST client for the InstanceGroups service.

The InstanceGroups API.

Attributes

instance_groups_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the InstanceGroups Client class.

See {::Google::Cloud::Compute::V1::InstanceGroups::Rest::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all InstanceGroups clients
::Google::Cloud::Compute::V1::InstanceGroups::Rest::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Compute", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.add_instances.timeout = 600.0

    default_config.rpcs.aggregated_list.timeout = 600.0
    default_config.rpcs.aggregated_list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.delete.timeout = 600.0

    default_config.rpcs.get.timeout = 600.0
    default_config.rpcs.get.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.insert.timeout = 600.0

    default_config.rpcs.list.timeout = 600.0
    default_config.rpcs.list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_instances.timeout = 600.0

    default_config.rpcs.remove_instances.timeout = 600.0

    default_config.rpcs.set_named_ports.timeout = 600.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new InstanceGroups REST client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Compute::V1::InstanceGroups::Rest::Client.new

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

@yield [config] Configure the InstanceGroups client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 136
def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @instance_groups_stub = ::Google::Cloud::Compute::V1::InstanceGroups::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Public Instance Methods

add_instances(request, options = nil) { |result, response| ... } click to toggle source

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

@overload add_instances(request, options = nil)

Pass arguments to `add_instances` via a request object, either of type
{::Google::Cloud::Compute::V1::AddInstancesInstanceGroupRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::AddInstancesInstanceGroupRequest, ::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.
@param 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

@overload add_instances(instance_group: nil, instance_groups_add_instances_request_resource: nil, project: nil, request_id: nil, zone: nil)

Pass arguments to `add_instances` 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).

@param instance_group [::String]
  The name of the instance group where you are adding instances.
@param instance_groups_add_instances_request_resource [::Google::Cloud::Compute::V1::InstanceGroupsAddInstancesRequest, ::Hash]
  The body resource for this request
@param project [::String]
  Project ID for this request.
@param 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).
@param zone [::String]
  The name of the zone where the instance group is located.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 196
def add_instances request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AddInstancesInstanceGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.add_instances.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.add_instances.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.add_instances request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
aggregated_list(request, options = nil) { |result, response| ... } click to toggle source

Retrieves the list of instance groups and sorts them by zone.

@overload aggregated_list(request, options = nil)

Pass arguments to `aggregated_list` via a request object, either of type
{::Google::Cloud::Compute::V1::AggregatedListInstanceGroupsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::AggregatedListInstanceGroupsRequest, ::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.
@param 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

@overload aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil)

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).

@param 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) ```
@param 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.
@param 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`)
@param 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.
@param 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.
@param project [::String]
  Project ID for this request.
@param return_partial_success [::Boolean]
  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstanceGroupsScopedList>] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstanceGroupsScopedList>]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 280
def aggregated_list request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AggregatedListInstanceGroupsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.aggregated_list.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.aggregated_list.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.aggregated_list request, options do |result, response|
    result = ::Gapic::Rest::PagedEnumerable.new @instance_groups_stub, :aggregated_list, "items", request, result, options
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
configure() { |config| ... } click to toggle source

Configure the InstanceGroups 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 {::Google::Cloud::Compute::V1::InstanceGroups::Rest::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 115
def configure
  yield @config if block_given?
  @config
end
delete(request, options = nil) { |result, response| ... } click to toggle source

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

@overload delete(request, options = nil)

Pass arguments to `delete` via a request object, either of type
{::Google::Cloud::Compute::V1::DeleteInstanceGroupRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::DeleteInstanceGroupRequest, ::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.
@param 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

@overload delete(instance_group: nil, project: nil, request_id: nil, zone: nil)

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).

@param instance_group [::String]
  The name of the instance group to delete.
@param project [::String]
  Project ID for this request.
@param 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).
@param zone [::String]
  The name of the zone where the instance group is located.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 352
def delete request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteInstanceGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.delete.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.delete request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
get(request, options = nil) { |result, response| ... } click to toggle source

Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request.

For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

@overload get(request, options = nil)

Pass arguments to `get` via a request object, either of type
{::Google::Cloud::Compute::V1::GetInstanceGroupRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::GetInstanceGroupRequest, ::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.
@param 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

@overload get(instance_group: nil, project: nil, zone: nil)

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).

@param instance_group [::String]
  The name of the instance group.
@param project [::String]
  Project ID for this request.
@param zone [::String]
  The name of the zone where the instance group is located.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::InstanceGroup] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::InstanceGroup]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 420
def get request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetInstanceGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.get.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.get request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
insert(request, options = nil) { |result, response| ... } click to toggle source

Creates an instance group in the specified project using the parameters that are included in the request.

@overload insert(request, options = nil)

Pass arguments to `insert` via a request object, either of type
{::Google::Cloud::Compute::V1::InsertInstanceGroupRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::InsertInstanceGroupRequest, ::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.
@param 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

@overload insert(instance_group_resource: nil, project: nil, request_id: nil, zone: nil)

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).

@param instance_group_resource [::Google::Cloud::Compute::V1::InstanceGroup, ::Hash]
  The body resource for this request
@param project [::String]
  Project ID for this request.
@param 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).
@param zone [::String]
  The name of the zone where you want to create the instance group.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 491
def insert request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertInstanceGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.insert.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.insert.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.insert request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
list(request, options = nil) { |result, response| ... } click to toggle source

Retrieves the list of zonal instance group resources contained within the specified zone.

For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

@overload list(request, options = nil)

Pass arguments to `list` via a request object, either of type
{::Google::Cloud::Compute::V1::ListInstanceGroupsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::ListInstanceGroupsRequest, ::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.
@param 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

@overload list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil)

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).

@param 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) ```
@param 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`)
@param 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.
@param 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.
@param project [::String]
  Project ID for this request.
@param return_partial_success [::Boolean]
  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
@param zone [::String]
  The name of the zone where the instance group is located.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceGroup>] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceGroup>]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 577
def list request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListInstanceGroupsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.list.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.list request, options do |result, response|
    result = ::Gapic::Rest::PagedEnumerable.new @instance_groups_stub, :list, "items", request, result, options
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
list_instances(request, options = nil) { |result, response| ... } click to toggle source

Lists the instances in the specified instance group. The orderBy query parameter is not supported.

@overload list_instances(request, options = nil)

Pass arguments to `list_instances` via a request object, either of type
{::Google::Cloud::Compute::V1::ListInstancesInstanceGroupsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::ListInstancesInstanceGroupsRequest, ::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.
@param 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

@overload list_instances(filter: nil, instance_group: nil, instance_groups_list_instances_request_resource: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil)

Pass arguments to `list_instances` 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).

@param 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) ```
@param instance_group [::String]
  The name of the instance group from which you want to generate a list of included instances.
@param instance_groups_list_instances_request_resource [::Google::Cloud::Compute::V1::InstanceGroupsListInstancesRequest, ::Hash]
  The body resource for this request
@param 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`)
@param 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.
@param 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.
@param project [::String]
  Project ID for this request.
@param return_partial_success [::Boolean]
  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
@param zone [::String]
  The name of the zone where the instance group is located.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceWithNamedPorts>] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::InstanceWithNamedPorts>]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 665
def list_instances request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListInstancesInstanceGroupsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_instances.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.list_instances.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.list_instances request, options do |result, response|
    result = ::Gapic::Rest::PagedEnumerable.new @instance_groups_stub, :list_instances, "items", request, result, options
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
remove_instances(request, options = nil) { |result, response| ... } click to toggle source

Removes one or more instances from the specified instance group, but does not delete those instances.

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.

@overload remove_instances(request, options = nil)

Pass arguments to `remove_instances` via a request object, either of type
{::Google::Cloud::Compute::V1::RemoveInstancesInstanceGroupRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::RemoveInstancesInstanceGroupRequest, ::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.
@param 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

@overload remove_instances(instance_group: nil, instance_groups_remove_instances_request_resource: nil, project: nil, request_id: nil, zone: nil)

Pass arguments to `remove_instances` 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).

@param instance_group [::String]
  The name of the instance group where the specified instances will be removed.
@param instance_groups_remove_instances_request_resource [::Google::Cloud::Compute::V1::InstanceGroupsRemoveInstancesRequest, ::Hash]
  The body resource for this request
@param project [::String]
  Project ID for this request.
@param 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).
@param zone [::String]
  The name of the zone where the instance group is located.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 741
def remove_instances request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::RemoveInstancesInstanceGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.remove_instances.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.remove_instances.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.remove_instances request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
set_named_ports(request, options = nil) { |result, response| ... } click to toggle source

Sets the named ports for the specified instance group.

@overload set_named_ports(request, options = nil)

Pass arguments to `set_named_ports` via a request object, either of type
{::Google::Cloud::Compute::V1::SetNamedPortsInstanceGroupRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::SetNamedPortsInstanceGroupRequest, ::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.
@param 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

@overload set_named_ports(instance_group: nil, instance_groups_set_named_ports_request_resource: nil, project: nil, request_id: nil, zone: nil)

Pass arguments to `set_named_ports` 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).

@param instance_group [::String]
  The name of the instance group where the named ports are updated.
@param instance_groups_set_named_ports_request_resource [::Google::Cloud::Compute::V1::InstanceGroupsSetNamedPortsRequest, ::Hash]
  The body resource for this request
@param project [::String]
  Project ID for this request.
@param 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).
@param zone [::String]
  The name of the zone where the instance group is located.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/instance_groups/rest/client.rb, line 815
def set_named_ports request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetNamedPortsInstanceGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_named_ports.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.set_named_ports.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @instance_groups_stub.set_named_ports request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end