Module: Google::Cloud::Support

Defined in:
lib/google/cloud/support.rb,
lib/google/cloud/support/version.rb

Constant Summary collapse

VERSION = 
"1.0.1"

Class Method Summary collapse

Class Method Details

.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.

About CaseAttachmentService

A service to manage file attachment for Google Cloud support cases.

Parameters:

  • 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.



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/google/cloud/support.rb', line 67

def self.case_attachment_service version: :v2, &block
  require "google/cloud/support/#{version.to_s.downcase}"

  package_name = Google::Cloud::Support
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Support.const_get(package_name).const_get(:CaseAttachmentService)
  service_module.const_get(:Client).new(&block)
end

.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.

About CaseService

A service to manage Google Cloud support cases.

Parameters:

  • 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.



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/google/cloud/support.rb', line 97

def self.case_service version: :v2, &block
  require "google/cloud/support/#{version.to_s.downcase}"

  package_name = Google::Cloud::Support
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Support.const_get(package_name).const_get(:CaseService)
  service_module.const_get(:Client).new(&block)
end

.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.

About CommentService

A service to manage comments on cases.

Parameters:

  • 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.



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/google/cloud/support.rb', line 127

def self.comment_service version: :v2, &block
  require "google/cloud/support/#{version.to_s.downcase}"

  package_name = Google::Cloud::Support
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Support.const_get(package_name).const_get(:CommentService)
  service_module.const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.support| ... } ⇒ ::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:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



166
167
168
169
170
 
# File 'lib/google/cloud/support.rb', line 166

def self.configure
  yield ::Google::Cloud.configure.support if block_given?

  ::Google::Cloud.configure.support
end