Vision AI V1 API - Class Google::Cloud::VisionAI::V1::HealthCheckService::Client (v0.2.0)

Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::HealthCheckService::Client.

Client for the HealthCheckService service.

HealthCheckService provides an interface for Vertex AI Vision Cluster Health Check.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the HealthCheckService Client class.

See Configuration for a description of the configuration fields.

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

#configure

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

Configure the HealthCheckService 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
Returns

#health_check

def health_check(request, options = nil) -> ::Google::Cloud::VisionAI::V1::HealthCheckResponse
def health_check(cluster: nil) -> ::Google::Cloud::VisionAI::V1::HealthCheckResponse

HealthCheck method checks the health status of the cluster.

Overloads 
def health_check(request, options = nil) -> ::Google::Cloud::VisionAI::V1::HealthCheckResponse
Pass arguments to health_check via a request object, either of type Google::Cloud::VisionAI::V1::HealthCheckRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::HealthCheckRequest, ::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. 
def health_check(cluster: nil) -> ::Google::Cloud::VisionAI::V1::HealthCheckResponse
Pass arguments to health_check 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).
Parameter
  • cluster (::String) — The parent of the resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::HealthCheckService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::HealthCheckRequest.new

# Call the health_check method.
result = client.health_check request

# The returned object is of type Google::Cloud::VisionAI::V1::HealthCheckResponse.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

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

Create a new HealthCheckService client object.

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

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

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)