class Google::Cloud::AppEngine::V1::Instances::Client

Client for the Instances service.

Manages instances of a version.

Attributes

instances_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::AppEngine::V1::Instances::Operations]

Public Class Methods

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

Configure the Instances Client class.

See {::Google::Cloud::AppEngine::V1::Instances::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Instances clients
::Google::Cloud::AppEngine::V1::Instances::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/app_engine/v1/instances/client.rb, line 54
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "AppEngine", "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
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new Instances client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::AppEngine::V1::Instances::Client.new

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

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

# File lib/google/cloud/app_engine/v1/instances/client.rb, line 107
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/appengine/v1/appengine_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

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

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.endpoint = @config.endpoint
  end

  @instances_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::AppEngine::V1::Instances::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

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

Configure the Instances 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::AppEngine::V1::Instances::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/app_engine/v1/instances/client.rb, line 86
def configure
  yield @config if block_given?
  @config
end
debug_instance(request, options = nil) { |response, operation| ... } click to toggle source

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in “debug mode”, the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.

Only applicable for instances in App Engine flexible environment.

@overload debug_instance(request, options = nil)

Pass arguments to `debug_instance` via a request object, either of type
{::Google::Cloud::AppEngine::V1::DebugInstanceRequest} or an equivalent Hash.

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

@overload debug_instance(name: nil, ssh_key: nil)

Pass arguments to `debug_instance` 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 name [::String]
  Name of the resource requested. Example:
  `apps/myapp/services/default/versions/v1/instances/instance-1`.
@param ssh_key [::String]
  Public SSH key to add to the instance. Examples:

  * `[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]`
  * `[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}`

  For more information, see
  [Adding and Removing SSH Keys](https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

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

# File lib/google/cloud/app_engine/v1/instances/client.rb, line 429
def debug_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::DebugInstanceRequest

  # 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
  metadata = @config.rpcs.debug_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  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::AppEngine::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.debug_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.debug_instance.retry_policy

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

  @instances_stub.call_rpc :debug_instance, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
delete_instance(request, options = nil) { |response, operation| ... } click to toggle source

Stops a running instance.

The instance might be automatically recreated based on the scaling settings of the version. For more information, see “How Instances are Managed” ([standard environment](cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | [flexible environment](cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).

To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to `STOPPED` with the [`apps.services.versions.patch`](cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.

@overload delete_instance(request, options = nil)

Pass arguments to `delete_instance` via a request object, either of type
{::Google::Cloud::AppEngine::V1::DeleteInstanceRequest} or an equivalent Hash.

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

@overload delete_instance(name: nil)

Pass arguments to `delete_instance` 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 name [::String]
  Name of the resource requested. Example:
  `apps/myapp/services/default/versions/v1/instances/instance-1`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

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

# File lib/google/cloud/app_engine/v1/instances/client.rb, line 344
def delete_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::DeleteInstanceRequest

  # 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
  metadata = @config.rpcs.delete_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  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::AppEngine::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_instance.retry_policy

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

  @instances_stub.call_rpc :delete_instance, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_instance(request, options = nil) { |response, operation| ... } click to toggle source

Gets instance information.

@overload get_instance(request, options = nil)

Pass arguments to `get_instance` via a request object, either of type
{::Google::Cloud::AppEngine::V1::GetInstanceRequest} or an equivalent Hash.

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

@overload get_instance(name: nil)

Pass arguments to `get_instance` 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 name [::String]
  Name of the resource requested. Example:
  `apps/myapp/services/default/versions/v1/instances/instance-1`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::AppEngine::V1::Instance] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::AppEngine::V1::Instance]

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

# File lib/google/cloud/app_engine/v1/instances/client.rb, line 264
def get_instance request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::GetInstanceRequest

  # 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
  metadata = @config.rpcs.get_instance.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  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::AppEngine::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_instance.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_instance.retry_policy

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

  @instances_stub.call_rpc :get_instance, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_instances(request, options = nil) { |response, operation| ... } click to toggle source

Lists the instances of a version.

Tip: To aggregate details about instances over time, see the [Stackdriver Monitoring API](cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).

@overload list_instances(request, options = nil)

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

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

@overload list_instances(parent: nil, page_size: nil, page_token: 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 parent [::String]
  Name of the parent Version resource. Example:
  `apps/myapp/services/default/versions/v1`.
@param page_size [::Integer]
  Maximum results to return per page.
@param page_token [::String]
  Continuation token for fetching the next page of results.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::Instance>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::Instance>]

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

# File lib/google/cloud/app_engine/v1/instances/client.rb, line 194
def list_instances request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::ListInstancesRequest

  # 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
  metadata = @config.rpcs.list_instances.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  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::AppEngine::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @instances_stub.call_rpc :list_instances, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @instances_stub, :list_instances, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end