Create a new client object for CaseAttachmentService.
By default, this returns an instance of
Google::Cloud::Support::V2::CaseAttachmentService::Client
for a gRPC client for version V2 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the CaseAttachmentService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the CaseAttachmentService service.
You can determine whether the method will succeed by calling
Support.case_attachment_service_available?.
About CaseAttachmentService
A service to manage file attachments for Google Cloud support cases.
Parameter
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to :v2.
Returns
(::Object) — A client object for the specified version.
Determines whether the CaseAttachmentService service is supported by the current client.
If true, you can retrieve a client object by calling Support.case_attachment_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the CaseAttachmentService service,
or if the versioned client gem needs an update to support the CaseAttachmentService service.
Parameter
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to :v2.
By default, this returns an instance of
Google::Cloud::Support::V2::CaseService::Client
for a gRPC client for version V2 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the CaseService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the CaseService service.
You can determine whether the method will succeed by calling
Support.case_service_available?.
About CaseService
A service to manage Google Cloud support cases.
Parameter
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to :v2.
Returns
(::Object) — A client object for the specified version.
Determines whether the CaseService service is supported by the current client.
If true, you can retrieve a client object by calling Support.case_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the CaseService service,
or if the versioned client gem needs an update to support the CaseService service.
Parameter
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to :v2.
By default, this returns an instance of
Google::Cloud::Support::V2::CommentService::Client
for a gRPC client for version V2 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the CommentService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the CommentService service.
You can determine whether the method will succeed by calling
Support.comment_service_available?.
About CommentService
A service to manage comments on cases.
Parameter
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to :v2.
Returns
(::Object) — A client object for the specified version.
Determines whether the CommentService service is supported by the current client.
If true, you can retrieve a client object by calling Support.comment_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the CommentService service,
or if the versioned client gem needs an update to support the CommentService service.
Parameter
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to :v2.
Returns
(boolean) — Whether the service is available.
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-support library.
The following configuration parameters are supported:
credentials (type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name (type:String) -
The library name as recorded in instrumentation and logging.
lib_version (type:String) -
The library version as recorded in instrumentation and logging.
interceptors (type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout (type:Numeric) -
Default timeout in seconds.
metadata (type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy (type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay (type:Numeric) - The initial delay in seconds.
:max_delay (type:Numeric) - The max delay in seconds.
:multiplier (type:Numeric) - The incremental backoff multiplier.
:retry_codes (type:Array<String>) -
The error codes that should trigger a retry.
Yields
(::Google::Cloud.configure.support)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Support API - Module Google::Cloud::Support (v1.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.2 (latest)](/ruby/docs/reference/google-cloud-support/latest/Google-Cloud-Support)\n- [1.1.1](/ruby/docs/reference/google-cloud-support/1.1.1/Google-Cloud-Support)\n- [1.0.1](/ruby/docs/reference/google-cloud-support/1.0.1/Google-Cloud-Support)\n- [0.3.0](/ruby/docs/reference/google-cloud-support/0.3.0/Google-Cloud-Support)\n- [0.2.0](/ruby/docs/reference/google-cloud-support/0.2.0/Google-Cloud-Support)\n- [0.1.0](/ruby/docs/reference/google-cloud-support/0.1.0/Google-Cloud-Support) \nReference documentation and code samples for the Google Cloud Support API module Google::Cloud::Support.\n\nMethods\n-------\n\n### .case_attachment_service\n\n def self.case_attachment_service(version: :v2, &block) -\u003e ::Object\n\nCreate a new client object for CaseAttachmentService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Support::V2::CaseAttachmentService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-support-v2/latest/Google-Cloud-Support-V2-CaseAttachmentService-Client)\nfor a gRPC client for version V2 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the CaseAttachmentService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the CaseAttachmentService service.\nYou can determine whether the method will succeed by calling\n[Support.case_attachment_service_available?](/ruby/docs/reference/google-cloud-support/latest/Google-Cloud-Support#Google__Cloud__Support_case_attachment_service_available__class_ \"Google::Cloud::Support.case_attachment_service_available? (method)\").\n\n#### About CaseAttachmentService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nA service to manage file attachments for Google Cloud support cases. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v2)* --- The API version to connect to. Optional. Defaults to `:v2`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .case_attachment_service_available?\n\n def self.case_attachment_service_available?(version: :v2) -\u003e boolean\n\nDetermines whether the CaseAttachmentService service is supported by the current client.\nIf true, you can retrieve a client object by calling [Support.case_attachment_service](/ruby/docs/reference/google-cloud-support/latest/Google-Cloud-Support#Google__Cloud__Support_case_attachment_service_class_ \"Google::Cloud::Support.case_attachment_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the CaseAttachmentService service,\nor if the versioned client gem needs an update to support the CaseAttachmentService service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v2)* --- The API version to connect to. Optional. Defaults to `:v2`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .case_service\n\n def self.case_service(version: :v2, &block) -\u003e ::Object\n\nCreate a new client object for CaseService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Support::V2::CaseService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-support-v2/latest/Google-Cloud-Support-V2-CaseService-Client)\nfor a gRPC client for version V2 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the CaseService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the CaseService service.\nYou can determine whether the method will succeed by calling\n[Support.case_service_available?](/ruby/docs/reference/google-cloud-support/latest/Google-Cloud-Support#Google__Cloud__Support_case_service_available__class_ \"Google::Cloud::Support.case_service_available? (method)\").\n\n#### About CaseService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nA service to manage Google Cloud support cases. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v2)* --- The API version to connect to. Optional. Defaults to `:v2`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .case_service_available?\n\n def self.case_service_available?(version: :v2) -\u003e boolean\n\nDetermines whether the CaseService service is supported by the current client.\nIf true, you can retrieve a client object by calling [Support.case_service](/ruby/docs/reference/google-cloud-support/latest/Google-Cloud-Support#Google__Cloud__Support_case_service_class_ \"Google::Cloud::Support.case_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the CaseService service,\nor if the versioned client gem needs an update to support the CaseService service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v2)* --- The API version to connect to. Optional. Defaults to `:v2`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .comment_service\n\n def self.comment_service(version: :v2, &block) -\u003e ::Object\n\nCreate a new client object for CommentService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Support::V2::CommentService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-support-v2/latest/Google-Cloud-Support-V2-CommentService-Client)\nfor a gRPC client for version V2 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the CommentService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the CommentService service.\nYou can determine whether the method will succeed by calling\n[Support.comment_service_available?](/ruby/docs/reference/google-cloud-support/latest/Google-Cloud-Support#Google__Cloud__Support_comment_service_available__class_ \"Google::Cloud::Support.comment_service_available? (method)\").\n\n#### About CommentService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nA service to manage comments on cases. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v2)* --- The API version to connect to. Optional. Defaults to `:v2`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .comment_service_available?\n\n def self.comment_service_available?(version: :v2) -\u003e boolean\n\nDetermines whether the CommentService service is supported by the current client.\nIf true, you can retrieve a client object by calling [Support.comment_service](/ruby/docs/reference/google-cloud-support/latest/Google-Cloud-Support#Google__Cloud__Support_comment_service_class_ \"Google::Cloud::Support.comment_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the CommentService service,\nor if the versioned client gem needs an update to support the CommentService service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v2)* --- The API version to connect to. Optional. Defaults to `:v2`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-support library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.support) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.1.2\""]]