Class: Google::Cloud::VisionAI::V1::StreamingService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb

Overview

REST client for the StreamingService service.

Streaming service for receiving and sending packets.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#series_path

Constructor Details

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

Create a new StreamingService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::VisionAI::V1::StreamingService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::VisionAI::V1::StreamingService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the StreamingService client.

Yield Parameters:



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 128

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

  @streaming_service_stub = ::Google::Cloud::VisionAI::V1::StreamingService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @streaming_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

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @streaming_service_stub.endpoint
    config.universe_domain = @streaming_service_stub.universe_domain
    config.logger = @streaming_service_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @streaming_service_stub.endpoint
    config.universe_domain = @streaming_service_stub.universe_domain
    config.logger = @streaming_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

  • (Google::Iam::V1::IAMPolicy::Rest::Client) 


198
199
200
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 198

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Rest::Client) 


191
192
193
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 191

def location_client
  @location_client
end

Class Method Details

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

Configure the StreamingService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all StreamingService clients
::Google::Cloud::VisionAI::V1::StreamingService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "VisionAI", "V1"]
    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
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#acquire_lease(request, options = nil) ⇒ ::Google::Cloud::VisionAI::V1::Lease #acquire_lease(series: nil, owner: nil, term: nil, lease_type: nil) ⇒ ::Google::Cloud::VisionAI::V1::Lease

AcquireLease acquires a lease.

Examples:

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::StreamingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::AcquireLeaseRequest.new

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

# The returned object is of type Google::Cloud::VisionAI::V1::Lease.
p result

Overloads:

  • #acquire_lease(request, options = nil) ⇒ ::Google::Cloud::VisionAI::V1::Lease

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

    Parameters:

    • request (::Google::Cloud::VisionAI::V1::AcquireLeaseRequest, ::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.

  • #acquire_lease(series: nil, owner: nil, term: nil, lease_type: nil) ⇒ ::Google::Cloud::VisionAI::V1::Lease

    Pass arguments to acquire_lease 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:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 260

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VisionAI::V1::AcquireLeaseRequest

  # 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.acquire_lease.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::VisionAI::V1::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.acquire_lease.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.acquire_lease.retry_policy

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

  @streaming_service_stub.acquire_lease 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 StreamingService 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:



98
99
100
101
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 98

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


205
206
207
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 205

def logger
  @streaming_service_stub.logger
end

#release_lease(request, options = nil) ⇒ ::Google::Cloud::VisionAI::V1::ReleaseLeaseResponse #release_lease(id: nil, series: nil, owner: nil) ⇒ ::Google::Cloud::VisionAI::V1::ReleaseLeaseResponse

RleaseLease releases a lease.

Examples:

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::StreamingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::ReleaseLeaseRequest.new

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

# The returned object is of type Google::Cloud::VisionAI::V1::ReleaseLeaseResponse.
p result

Overloads:

  • #release_lease(request, options = nil) ⇒ ::Google::Cloud::VisionAI::V1::ReleaseLeaseResponse

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

    Parameters:

    • request (::Google::Cloud::VisionAI::V1::ReleaseLeaseRequest, ::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.

  • #release_lease(id: nil, series: nil, owner: nil) ⇒ ::Google::Cloud::VisionAI::V1::ReleaseLeaseResponse

    Pass arguments to release_lease 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:

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

      Lease id.

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

      Series name.

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

      Lease owner.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 426

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VisionAI::V1::ReleaseLeaseRequest

  # 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.release_lease.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::VisionAI::V1::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.release_lease.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.release_lease.retry_policy

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

  @streaming_service_stub.release_lease 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

#renew_lease(request, options = nil) ⇒ ::Google::Cloud::VisionAI::V1::Lease #renew_lease(id: nil, series: nil, owner: nil, term: nil) ⇒ ::Google::Cloud::VisionAI::V1::Lease

RenewLease renews a lease.

Examples:

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::StreamingService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::RenewLeaseRequest.new

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

# The returned object is of type Google::Cloud::VisionAI::V1::Lease.
p result

Overloads:

  • #renew_lease(request, options = nil) ⇒ ::Google::Cloud::VisionAI::V1::Lease

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

    Parameters:

    • request (::Google::Cloud::VisionAI::V1::RenewLeaseRequest, ::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.

  • #renew_lease(id: nil, series: nil, owner: nil, term: nil) ⇒ ::Google::Cloud::VisionAI::V1::Lease

    Pass arguments to renew_lease 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:

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

      Lease id.

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

      Series name.

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

      Lease owner.

    • term (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      Lease term.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 344

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VisionAI::V1::RenewLeaseRequest

  # 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.renew_lease.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::VisionAI::V1::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.renew_lease.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.renew_lease.retry_policy

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

  @streaming_service_stub.renew_lease 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


108
109
110
 
# File 'lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb', line 108

def universe_domain
  @streaming_service_stub.universe_domain
end