Module: Google::Cloud::Support

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

Constant Summary collapse

VERSION = 
"1.1.3"

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.

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

About CaseAttachmentService

A service to manage file attachments 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.



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/support.rb', line 72

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

Parameters:

  • version (::String, ::Symbol) (defaults to: :v2) —

    The API version to connect to. Optional. Defaults to :v2.

Returns:

  • (boolean) —

    Whether the service is available.



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

def self.case_attachment_service_available? version: :v2
  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
  return false unless package_name
  service_module = Google::Cloud::Support.const_get package_name
  return false unless service_module.const_defined? :CaseAttachmentService
  service_module = service_module.const_get :CaseAttachmentService
  service_module.const_defined? :Client
rescue ::LoadError
  false
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.

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

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.



133
134
135
136
137
138
139
140
141
142
 
# File 'lib/google/cloud/support.rb', line 133

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

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

Parameters:

  • version (::String, ::Symbol) (defaults to: :v2) —

    The API version to connect to. Optional. Defaults to :v2.

Returns:

  • (boolean) —

    Whether the service is available.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/google/cloud/support.rb', line 155

def self.case_service_available? version: :v2
  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
  return false unless package_name
  service_module = Google::Cloud::Support.const_get package_name
  return false unless service_module.const_defined? :CaseService
  service_module = service_module.const_get :CaseService
  service_module.const_defined? :Client
rescue ::LoadError
  false
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.

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

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.



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/google/cloud/support.rb', line 194

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

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

Parameters:

  • version (::String, ::Symbol) (defaults to: :v2) —

    The API version to connect to. Optional. Defaults to :v2.

Returns:

  • (boolean) —

    Whether the service is available.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/google/cloud/support.rb', line 216

def self.comment_service_available? version: :v2
  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
  return false unless package_name
  service_module = Google::Cloud::Support.const_get package_name
  return false unless service_module.const_defined? :CommentService
  service_module = service_module.const_get :CommentService
  service_module.const_defined? :Client
rescue ::LoadError
  false
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



259
260
261
262
263
 
# File 'lib/google/cloud/support.rb', line 259

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

  ::Google::Cloud.configure.support
end