# Modify the configuration for all HealthCheckService clients::Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.configuredo|config|config.timeout=10.0end
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.
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.
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
(result, operation) — Access the result along with the TransportOperation object
(::Google::Cloud::Error) — if the REST call 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::Rest::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_checkrequest# The returned object is of type Google::Cloud::VisionAI::V1::HealthCheckResponse.presult
# Create a client using the default configurationclient=::Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.new# Create a client using a custom configurationclient=::Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.newdo|config|config.timeout=10.0end
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client (v1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.\n\nREST client for the HealthCheckService service.\n\n\n\u003cbr /\u003e\n\nHealthCheckService provides an interface for Vertex AI Vision Cluster Health\nCheck. \n\nInherits\n--------\n\n- Object \n\nIncludes\n--------\n\n- [Google::Cloud::VisionAI::V1::HealthCheckService::Paths](./Google-Cloud-VisionAI-V1-HealthCheckService-Paths)\n\nMethods\n-------\n\n### .configure\n\n def self.configure() { |config| ... } -\u003e Client::Configuration\n\nConfigure the HealthCheckService Client class.\n\n\n\u003cbr /\u003e\n\nSee [Configuration](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client-Configuration \"Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client::Configuration (class)\")\nfor a description of the configuration fields. \n**Yields**\n\n- (config) --- Configure the Client client. \n**Yield Parameter**\n\n- **config** ([Client::Configuration](./Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client-Configuration)) \n**Returns**\n\n- ([Client::Configuration](./Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client-Configuration))\n**Example** \n\n```ruby\n# Modify the configuration for all HealthCheckService clients\n::Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.configure do |config|\n config.timeout = 10.0\nend\n```\n\n### #configure\n\n def configure() { |config| ... } -\u003e Client::Configuration\n\nConfigure the HealthCheckService Client instance.\n\n\nThe configuration is set to the derived mode, meaning that values can be changed,\nbut structural changes (adding new fields, etc.) are not allowed. Structural changes\nshould be made on [Client.configure](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client#Google__Cloud__VisionAI__V1__HealthCheckService__Rest__Client_configure_class_ \"Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.configure (method)\").\n\n\u003cbr /\u003e\n\nSee [Configuration](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client-Configuration \"Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client::Configuration (class)\")\nfor a description of the configuration fields. \n**Yields**\n\n- (config) --- Configure the Client client. \n**Yield Parameter**\n\n- **config** ([Client::Configuration](./Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client-Configuration)) \n**Returns**\n\n- ([Client::Configuration](./Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client-Configuration))\n\n### #health_check\n\n def health_check(request, options = nil) -\u003e ::Google::Cloud::VisionAI::V1::HealthCheckResponse\n def health_check(cluster: nil) -\u003e ::Google::Cloud::VisionAI::V1::HealthCheckResponse\n\nHealthCheck method checks the health status of the cluster. \n**Overloads** \n\n def health_check(request, options = nil) -\u003e ::Google::Cloud::VisionAI::V1::HealthCheckResponse\n\nPass arguments to `health_check` via a request object, either of type [Google::Cloud::VisionAI::V1::HealthCheckRequest](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-HealthCheckRequest \"Google::Cloud::VisionAI::V1::HealthCheckRequest (class)\") or an equivalent Hash. \n**Parameters**\n\n- **request** ([::Google::Cloud::VisionAI::V1::HealthCheckRequest](./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.\n- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional. \n\n def health_check(cluster: nil) -\u003e ::Google::Cloud::VisionAI::V1::HealthCheckResponse\n\nPass 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). \n**Parameter**\n\n- **cluster** (::String) --- The parent of the resource. \n**Yields**\n\n- (result, operation) --- Access the result along with the TransportOperation object \n**Yield Parameters**\n\n- **result** ([::Google::Cloud::VisionAI::V1::HealthCheckResponse](./Google-Cloud-VisionAI-V1-HealthCheckResponse))\n- **operation** (::Gapic::Rest::TransportOperation) \n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::HealthCheckResponse](./Google-Cloud-VisionAI-V1-HealthCheckResponse)) \n**Raises**\n\n- (::Google::Cloud::Error) --- if the REST call is aborted.\n**Example**\n\nBasic example \n\n```ruby\nrequire \"google/cloud/vision_ai/v1\"\n\n# Create a client object. The client can be reused for multiple calls.\nclient = Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.new\n\n# Create a request. To set request fields, pass in keyword arguments.\nrequest = Google::Cloud::VisionAI::V1::HealthCheckRequest.new\n\n# Call the health_check method.\nresult = client.health_check request\n\n# The returned object is of type Google::Cloud::VisionAI::V1::HealthCheckResponse.\np result\n```\n\n### #iam_policy_client\n\n def iam_policy_client() -\u003e Google::Iam::V1::IAMPolicy::Rest::Client\n\nGet the associated client for mix-in of the IAMPolicy. \n**Returns**\n\n- (Google::Iam::V1::IAMPolicy::Rest::Client)\n\n### #initialize\n\n def initialize() { |config| ... } -\u003e Client\n\nCreate a new HealthCheckService REST client object. \n**Yields**\n\n- (config) --- Configure the HealthCheckService client. \n**Yield Parameter**\n\n- **config** ([Client::Configuration](./Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client-Configuration)) \n**Returns**\n\n- ([Client](./Google-Cloud-VisionAI-V1-HealthCheckService-Rest-Client)) --- a new instance of Client\n**Example** \n\n```ruby\n# Create a client using the default configuration\nclient = ::Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.new\n\n# Create a client using a custom configuration\nclient = ::Google::Cloud::VisionAI::V1::HealthCheckService::Rest::Client.new do |config|\n config.timeout = 10.0\nend\n```\n\n### #location_client\n\n def location_client() -\u003e Google::Cloud::Location::Locations::Rest::Client\n\nGet the associated client for mix-in of the Locations. \n**Returns**\n\n- (Google::Cloud::Location::Locations::Rest::Client)\n\n### #logger\n\n def logger() -\u003e Logger\n\nThe logger used for request/response debug logging. \n**Returns**\n\n- (Logger)\n\n### #universe_domain\n\n def universe_domain() -\u003e String\n\nThe effective universe domain \n**Returns**\n\n- (String)"]]
