Class: Google::Cloud::Support::V2beta::CaseService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/support/v2beta/case_service/rest/client.rb

Overview

REST client for the CaseService service.

A service to manage Google Cloud support cases.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#case_path, #organization_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new CaseService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Support::V2beta::CaseService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CaseService client.

Yield Parameters:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 154

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @case_service_stub = ::Google::Cloud::Support::V2beta::CaseService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @case_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the CaseService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CaseService clients
::Google::Cloud::Support::V2beta::CaseService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Support", "V2beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.get_case.timeout = 60.0
    default_config.rpcs.get_case.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_cases.timeout = 60.0
    default_config.rpcs.list_cases.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.search_cases.timeout = 60.0
    default_config.rpcs.search_cases.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_case.timeout = 60.0

    default_config.rpcs.update_case.timeout = 60.0

    default_config.rpcs.escalate_case.timeout = 60.0

    default_config.rpcs.close_case.timeout = 60.0

    default_config.rpcs.search_case_classifications.timeout = 60.0
    default_config.rpcs.search_case_classifications.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#close_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case #close_case(name: nil) ⇒ ::Google::Cloud::Support::V2beta::Case

Close a case.

Examples:

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::CloseCaseRequest.new

# Call the close_case method.
result = client.close_case request

# The returned object is of type Google::Cloud::Support::V2beta::Case.
p result

Overloads:

  • #close_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to close_case via a request object, either of type Google::Cloud::Support::V2beta::CloseCaseRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Support::V2beta::CloseCaseRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #close_case(name: nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to close_case 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the case to close.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 824

def close_case request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::CloseCaseRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.close_case.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.close_case.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.close_case.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @case_service_stub.close_case request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the CaseService Client instance.

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

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



124
125
126
127
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 124

def configure
  yield @config if block_given?
  @config
end

#create_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case #create_case(parent: nil) ⇒ ::Google::Cloud::Support::V2beta::Case

Create a new case and associate it with a parent.

It must have the following fields set: display_name, description, classification, and priority. If you're just testing the API and don't want to route your case to an agent, set testCase=true.

Examples:

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::CreateCaseRequest.new

# Call the create_case method.
result = client.create_case request

# The returned object is of type Google::Cloud::Support::V2beta::Case.
p result

Overloads:

  • #create_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to create_case via a request object, either of type Google::Cloud::Support::V2beta::CreateCaseRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Support::V2beta::CreateCaseRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_case(parent: nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to create_case 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the parent under which the case should be created.

    • case (::Google::Cloud::Support::V2beta::Case, ::Hash) —

      Required. The case to be created.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 573

def create_case request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::CreateCaseRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_case.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_case.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_case.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @case_service_stub.create_case request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#escalate_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case #escalate_case(name: nil, escalation: nil) ⇒ ::Google::Cloud::Support::V2beta::Case

Escalate a case, starting the Google Cloud Support escalation management process.

This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that.

Examples:

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::EscalateCaseRequest.new

# Call the escalate_case method.
result = client.escalate_case request

# The returned object is of type Google::Cloud::Support::V2beta::Case.
p result

Overloads:

  • #escalate_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to escalate_case via a request object, either of type EscalateCaseRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Support::V2beta::EscalateCaseRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #escalate_case(name: nil, escalation: nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to escalate_case 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the case to be escalated.

    • escalation (::Google::Cloud::Support::V2beta::Escalation, ::Hash) (defaults to: nil) —

      The escalation information to be sent with the escalation request.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 746

def escalate_case request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::EscalateCaseRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.escalate_case.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.escalate_case.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.escalate_case.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @case_service_stub.escalate_case request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case #get_case(name: nil) ⇒ ::Google::Cloud::Support::V2beta::Case

Retrieve a case.

Examples:

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::GetCaseRequest.new

# Call the get_case method.
result = client.get_case request

# The returned object is of type Google::Cloud::Support::V2beta::Case.
p result

Overloads:

  • #get_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to get_case via a request object, either of type GetCaseRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Support::V2beta::GetCaseRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_case(name: nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to get_case 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The full name of a case to be retrieved.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 250

def get_case request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::GetCaseRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_case.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_case.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_case.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @case_service_stub.get_case request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_cases(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::Case> #list_cases(parent: nil, filter: nil, page_size: nil, page_token: nil, product_line: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::Case>

Retrieve all cases under a parent, but not its children.

For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use cases.search.

Examples:

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::ListCasesRequest.new

# Call the list_cases method.
result = client.list_cases request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Support::V2beta::Case.
  p item
end

Overloads:

  • #list_cases(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::Case>

    Pass arguments to list_cases via a request object, either of type ListCasesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Support::V2beta::ListCasesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_cases(parent: nil, filter: nil, page_size: nil, page_token: nil, product_line: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::Case>

    Pass arguments to list_cases 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of a parent to list cases under.

    • filter (::String) (defaults to: nil) —

      An expression used to filter cases.

      If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

      Expressions use the following fields separated by AND and specified with =:

      • state: Can be OPEN or CLOSED.
      • priority: Can be P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2.
      • creator.email: The email address of the case creator.

      EXAMPLES:

      • state=CLOSED
      • state=OPEN AND creator.email="[email protected]"
      • state=OPEN AND (priority=P0 OR priority=P1)
    • page_size (::Integer) (defaults to: nil) —

      The maximum number of cases fetched with each request. Defaults to 10.

    • page_token (::String) (defaults to: nil) —

      A token identifying the page of results to return. If unspecified, the first page is retrieved.

    • product_line (::Google::Cloud::Support::V2beta::ProductLine) (defaults to: nil) —

      The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 364

def list_cases request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::ListCasesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_cases.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_cases.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_cases.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @case_service_stub.list_cases request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @case_service_stub, :list_cases, "cases", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


201
202
203
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 201

def logger
  @case_service_stub.logger
end

#search_case_classifications(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::CaseClassification> #search_case_classifications(query: nil, page_size: nil, page_token: nil, product: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::CaseClassification>

Retrieve valid classifications to use when creating a support case.

Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by " > ". For example, "Technical Issue > Compute > Compute Engine".

Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, case.create requests using the classification will fail.

Examples:

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::SearchCaseClassificationsRequest.new

# Call the search_case_classifications method.
result = client.search_case_classifications request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Support::V2beta::CaseClassification.
  p item
end

Overloads:

  • #search_case_classifications(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::CaseClassification>

    Pass arguments to search_case_classifications via a request object, either of type SearchCaseClassificationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Support::V2beta::SearchCaseClassificationsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #search_case_classifications(query: nil, page_size: nil, page_token: nil, product: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::CaseClassification>

    Pass arguments to search_case_classifications 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).

    Parameters:

    • query (::String) (defaults to: nil) —

      An expression used to filter case classifications.

      If it's an empty string, then no filtering happens. Otherwise, case classifications will be returned that match the filter.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of classifications fetched with each request.

    • page_token (::String) (defaults to: nil) —

      A token identifying the page of results to return. If unspecified, the first page is retrieved.

    • product (::Google::Cloud::Support::V2beta::Product, ::Hash) (defaults to: nil) —

      Optional. The product to return case classifications for.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 925

def search_case_classifications request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::SearchCaseClassificationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.search_case_classifications.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_case_classifications.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_case_classifications.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @case_service_stub.search_case_classifications request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @case_service_stub, :search_case_classifications, "case_classifications", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_cases(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::Case> #search_cases(parent: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::Case>

Search for cases using a query.

Examples:

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::SearchCasesRequest.new

# Call the search_cases method.
result = client.search_cases request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Support::V2beta::Case.
  p item
end

Overloads:

  • #search_cases(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::Case>

    Pass arguments to search_cases via a request object, either of type SearchCasesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Support::V2beta::SearchCasesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #search_cases(parent: nil, query: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Support::V2beta::Case>

    Pass arguments to search_cases 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      The name of the parent resource to search for cases under.

    • query (::String) (defaults to: nil) —

      An expression used to filter cases.

      Expressions use the following fields separated by AND and specified with =:

      • organization: An organization name in the form organizations/<organization_id>.
      • project: A project name in the form projects/<project_id>.
      • state: Can be OPEN or CLOSED.
      • priority: Can be P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2.
      • creator.email: The email address of the case creator.

      You must specify either organization or project.

      To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search".

      To search only cases updated after a certain date, use update_time restricted with that particular date, time, and timezone in ISO datetime format. For example, update_time>"2020-01-01T00:00:00-05:00". update_time only supports the greater than operator (>).

      Examples:

      • organization="organizations/123456789"
      • project="projects/my-project-id"
      • project="projects/123456789"
      • organization="organizations/123456789" AND state=CLOSED
      • project="projects/my-project-id" AND creator.email="[email protected]"
      • project="projects/my-project-id" AND (priority=P0 OR priority=P1)
    • page_size (::Integer) (defaults to: nil) —

      The maximum number of cases fetched with each request. The default page size is 10.

    • page_token (::String) (defaults to: nil) —

      A token identifying the page of results to return. If unspecified, the first page is retrieved.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 487

def search_cases request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::SearchCasesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.search_cases.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_cases.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_cases.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @case_service_stub.search_cases request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @case_service_stub, :search_cases, "cases", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


134
135
136
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 134

def universe_domain
  @case_service_stub.universe_domain
end

#update_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case #update_case ⇒ ::Google::Cloud::Support::V2beta::Case

Update a case. Only some fields can be updated.

Examples:

Basic example

require "google/cloud/support/v2beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Support::V2beta::CaseService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Support::V2beta::UpdateCaseRequest.new

# Call the update_case method.
result = client.update_case request

# The returned object is of type Google::Cloud::Support::V2beta::Case.
p result

Overloads:

  • #update_case(request, options = nil) ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to update_case via a request object, either of type UpdateCaseRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Support::V2beta::UpdateCaseRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_case ⇒ ::Google::Cloud::Support::V2beta::Case

    Pass arguments to update_case 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).

    Parameters:

    • case (::Google::Cloud::Support::V2beta::Case, ::Hash) —

      Required. The case to update.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) —

      A list of attributes of the case that should be updated. Supported values are priority, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields are updated.

      Be careful - if you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for subscriber_email_addresses, then subscriber_email_addresses is updated to empty.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/google/cloud/support/v2beta/case_service/rest/client.rb', line 660

def update_case request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::UpdateCaseRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_case.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_case.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_case.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @case_service_stub.update_case request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end