Reference documentation and code samples for the Google Cloud Support API module Google::Cloud::Support.
Methods
.case_attachment_service
def self.case_attachment_service(version: :v2, &block) -> ::Object
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 attachment for Google Cloud support cases.
-
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to
:v2
.
- (::Object) — A client object for the specified version.
.case_attachment_service_available?
def self.case_attachment_service_available?(version: :v2) -> boolean
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.
-
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to
:v2
.
- (boolean) — Whether the service is available.
.case_service
def self.case_service(version: :v2, &block) -> ::Object
Create a new client object for CaseService.
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.
-
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to
:v2
.
- (::Object) — A client object for the specified version.
.case_service_available?
def self.case_service_available?(version: :v2) -> boolean
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.
-
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to
:v2
.
- (boolean) — Whether the service is available.
.comment_service
def self.comment_service(version: :v2, &block) -> ::Object
Create a new client object for CommentService.
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.
-
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to
:v2
.
- (::Object) — A client object for the specified version.
.comment_service_available?
def self.comment_service_available?(version: :v2) -> boolean
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.
-
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to
:v2
.
- (boolean) — Whether the service is available.
.configure
def self.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.
- (::Google::Cloud.configure.support)
- (::Google::Cloud::Config) — The default configuration used by this library
Constants
VERSION
value: "1.1.0"