Class: Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb

Overview

Client for the DataLabelingService service.

Service for the AI Platform Data Labeling API.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#annotated_dataset_path, #annotation_spec_set_path, #data_item_path, #dataset_path, #evaluation_job_path, #evaluation_path, #example_path, #instruction_path, #project_path

Constructor Details

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

Create a new DataLabelingService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the DataLabelingService client.

Yield Parameters:



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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 253

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/datalabeling/v1beta1/data_labeling_service_services_pb"

  # 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

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @data_labeling_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Instance Attribute Details

#operations_client::Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Operations (readonly)

Get the associated client for long-running operations.



305
306
307
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 305

def operations_client
  @operations_client
end

Class Method Details

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

Configure the DataLabelingService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all DataLabelingService clients
::Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



62
63
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 62

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DataLabeling", "V1beta1"]
    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.create_dataset.timeout = 30.0

    default_config.rpcs.get_dataset.timeout = 30.0
    default_config.rpcs.get_dataset.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_datasets.timeout = 30.0
    default_config.rpcs.list_datasets.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.delete_dataset.timeout = 30.0
    default_config.rpcs.delete_dataset.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.import_data.timeout = 30.0

    default_config.rpcs.export_data.timeout = 30.0
    default_config.rpcs.export_data.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_data_item.timeout = 30.0
    default_config.rpcs.get_data_item.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_data_items.timeout = 30.0
    default_config.rpcs.list_data_items.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_annotated_dataset.timeout = 30.0
    default_config.rpcs.get_annotated_dataset.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_annotated_datasets.timeout = 30.0
    default_config.rpcs.list_annotated_datasets.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.label_image.timeout = 30.0

    default_config.rpcs.label_video.timeout = 30.0

    default_config.rpcs.label_text.timeout = 30.0

    default_config.rpcs.get_example.timeout = 30.0
    default_config.rpcs.get_example.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_examples.timeout = 30.0
    default_config.rpcs.list_examples.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.create_annotation_spec_set.timeout = 30.0

    default_config.rpcs.get_annotation_spec_set.timeout = 30.0
    default_config.rpcs.get_annotation_spec_set.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_annotation_spec_sets.timeout = 30.0
    default_config.rpcs.list_annotation_spec_sets.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.delete_annotation_spec_set.timeout = 30.0
    default_config.rpcs.delete_annotation_spec_set.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.create_instruction.timeout = 30.0

    default_config.rpcs.get_instruction.timeout = 30.0
    default_config.rpcs.get_instruction.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_instructions.timeout = 30.0
    default_config.rpcs.list_instructions.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.delete_instruction.timeout = 30.0
    default_config.rpcs.delete_instruction.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_evaluation.timeout = 30.0
    default_config.rpcs.get_evaluation.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.search_evaluations.timeout = 30.0
    default_config.rpcs.search_evaluations.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.search_example_comparisons.timeout = 30.0

    default_config.rpcs.create_evaluation_job.timeout = 30.0

    default_config.rpcs.update_evaluation_job.timeout = 30.0

    default_config.rpcs.get_evaluation_job.timeout = 30.0
    default_config.rpcs.get_evaluation_job.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.pause_evaluation_job.timeout = 30.0

    default_config.rpcs.resume_evaluation_job.timeout = 30.0

    default_config.rpcs.delete_evaluation_job.timeout = 30.0
    default_config.rpcs.delete_evaluation_job.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_evaluation_jobs.timeout = 30.0
    default_config.rpcs.list_evaluation_jobs.retry_policy = {
      initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the DataLabelingService 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:



223
224
225
226
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 223

def configure
  yield @config if block_given?
  @config
end

#create_annotation_spec_set(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet #create_annotation_spec_set(parent: nil, annotation_spec_set: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet

Creates an annotation spec set by providing a set of labels.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::CreateAnnotationSpecSetRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet.
p result

Overloads:

  • #create_annotation_spec_set(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::CreateAnnotationSpecSetRequest, ::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_annotation_spec_set(parent: nil, annotation_spec_set: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet

    Pass arguments to create_annotation_spec_set 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. AnnotationSpecSet resource parent, format: projects/{project_id}

    • annotation_spec_set (::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet, ::Hash) (defaults to: nil)

      Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1944

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::CreateAnnotationSpecSetRequest

  # 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
   = @config.rpcs.create_annotation_spec_set..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :create_annotation_spec_set, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_dataset(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Dataset #create_dataset(parent: nil, dataset: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Dataset

Creates dataset. If success return a Dataset resource.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::CreateDatasetRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::Dataset.
p result

Overloads:

  • #create_dataset(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Dataset

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::CreateDatasetRequest, ::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_dataset(parent: nil, dataset: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Dataset

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



356
357
358
359
360
361
362
363
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
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 356

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::CreateDatasetRequest

  # 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
   = @config.rpcs.create_dataset..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :create_dataset, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_evaluation_job(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob #create_evaluation_job(parent: nil, job: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob

Creates an evaluation job.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::CreateEvaluationJobRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::EvaluationJob.
p result

Overloads:

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 3015

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::CreateEvaluationJobRequest

  # 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
   = @config.rpcs.create_evaluation_job..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :create_evaluation_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_instruction(request, options = nil) ⇒ ::Gapic::Operation #create_instruction(parent: nil, instruction: nil) ⇒ ::Gapic::Operation

Creates an instruction for how data should be labeled.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::CreateInstructionRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_instruction(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::CreateInstructionRequest, ::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_instruction(parent: nil, instruction: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_instruction 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. Instruction resource parent, format: projects/{project_id}

    • instruction (::Google::Cloud::DataLabeling::V1beta1::Instruction, ::Hash) (defaults to: nil)

      Required. Instruction of how to perform the labeling task.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2317

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::CreateInstructionRequest

  # 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
   = @config.rpcs.create_instruction..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :create_instruction, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_annotated_dataset(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_annotated_dataset(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an annotated dataset by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::DeleteAnnotatedDatasetRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_annotated_dataset(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_annotated_dataset via a request object, either of type Google::Cloud::DataLabeling::V1beta1::DeleteAnnotatedDatasetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::DeleteAnnotatedDatasetRequest, ::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.

  • #delete_annotated_dataset(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_annotated_dataset 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. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1316

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::DeleteAnnotatedDatasetRequest

  # 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
   = @config.rpcs.delete_annotated_dataset..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :delete_annotated_dataset, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_annotation_spec_set(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_annotation_spec_set(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an annotation spec set by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::DeleteAnnotationSpecSetRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_annotation_spec_set(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_annotation_spec_set via a request object, either of type Google::Cloud::DataLabeling::V1beta1::DeleteAnnotationSpecSetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::DeleteAnnotationSpecSetRequest, ::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.

  • #delete_annotation_spec_set(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_annotation_spec_set 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. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2221

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::DeleteAnnotationSpecSetRequest

  # 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
   = @config.rpcs.delete_annotation_spec_set..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :delete_annotation_spec_set, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_dataset(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_dataset(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a dataset by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::DeleteDatasetRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_dataset(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_dataset via a request object, either of type Google::Cloud::DataLabeling::V1beta1::DeleteDatasetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::DeleteDatasetRequest, ::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.

  • #delete_dataset(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_dataset 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. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 633

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::DeleteDatasetRequest

  # 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
   = @config.rpcs.delete_dataset..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :delete_dataset, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_evaluation_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_evaluation_job(name: nil) ⇒ ::Google::Protobuf::Empty

Stops and deletes an evaluation job.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::DeleteEvaluationJobRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_evaluation_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation_job via a request object, either of type Google::Cloud::DataLabeling::V1beta1::DeleteEvaluationJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::DeleteEvaluationJobRequest, ::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.

  • #delete_evaluation_job(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation_job 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. Name of the evaluation job that is going to be deleted. Format:

      "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 3470

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::DeleteEvaluationJobRequest

  # 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
   = @config.rpcs.delete_evaluation_job..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :delete_evaluation_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_instruction(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_instruction(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an instruction object by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::DeleteInstructionRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_instruction(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_instruction via a request object, either of type Google::Cloud::DataLabeling::V1beta1::DeleteInstructionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::DeleteInstructionRequest, ::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.

  • #delete_instruction(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_instruction 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. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2595

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::DeleteInstructionRequest

  # 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
   = @config.rpcs.delete_instruction..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :delete_instruction, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#export_data(request, options = nil) ⇒ ::Gapic::Operation #export_data(name: nil, annotated_dataset: nil, filter: nil, output_config: nil, user_email_address: nil) ⇒ ::Gapic::Operation

Exports data and annotations from dataset.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ExportDataRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #export_data(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ExportDataRequest, ::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.

  • #export_data(name: nil, annotated_dataset: nil, filter: nil, output_config: nil, user_email_address: nil) ⇒ ::Gapic::Operation

    Pass arguments to export_data 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. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

    • annotated_dataset (::String) (defaults to: nil)

      Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

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

      Optional. Filter is not supported at this moment.

    • output_config (::Google::Cloud::DataLabeling::V1beta1::OutputConfig, ::Hash) (defaults to: nil)

      Required. Specify the output destination.

    • user_email_address (::String) (defaults to: nil)

      Email of the user who started the export task and should be notified by email. If empty no notification will be sent.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 844

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ExportDataRequest

  # 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
   = @config.rpcs.export_data..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :export_data, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_annotated_dataset(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset #get_annotated_dataset(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset

Gets an annotated dataset by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::GetAnnotatedDatasetRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset.
p result

Overloads:

  • #get_annotated_dataset(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::GetAnnotatedDatasetRequest, ::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_annotated_dataset(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset

    Pass arguments to get_annotated_dataset 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. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1125

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::GetAnnotatedDatasetRequest

  # 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
   = @config.rpcs.get_annotated_dataset..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :get_annotated_dataset, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_annotation_spec_set(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet #get_annotation_spec_set(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet

Gets an annotation spec set by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::GetAnnotationSpecSetRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet.
p result

Overloads:

  • #get_annotation_spec_set(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::GetAnnotationSpecSetRequest, ::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_annotation_spec_set(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet

    Pass arguments to get_annotation_spec_set 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. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2031

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::GetAnnotationSpecSetRequest

  # 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
   = @config.rpcs.get_annotation_spec_set..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :get_annotation_spec_set, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_data_item(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::DataItem #get_data_item(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::DataItem

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::GetDataItemRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::DataItem.
p result

Overloads:

  • #get_data_item(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::DataItem

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::GetDataItemRequest, ::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_data_item(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::DataItem

    Pass arguments to get_data_item 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 data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
961
962
963
964
965
966
967
968
969
970
971
972
973
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 933

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::GetDataItemRequest

  # 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
   = @config.rpcs.get_data_item..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :get_data_item, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_dataset(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Dataset #get_dataset(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Dataset

Gets dataset by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::GetDatasetRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::Dataset.
p result

Overloads:

  • #get_dataset(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Dataset

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::GetDatasetRequest, ::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_dataset(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Dataset

    Pass arguments to get_dataset 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. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 443

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::GetDatasetRequest

  # 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
   = @config.rpcs.get_dataset..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :get_dataset, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_evaluation(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Evaluation #get_evaluation(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Evaluation

Gets an evaluation by resource name (to search, use projects.evaluations.search).

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::GetEvaluationRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::Evaluation.
p result

Overloads:

  • #get_evaluation(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Evaluation

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::GetEvaluationRequest, ::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_evaluation(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Evaluation

    Pass arguments to get_evaluation 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. Name of the evaluation. Format:

      "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}'

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2684

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::GetEvaluationRequest

  # 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
   = @config.rpcs.get_evaluation..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :get_evaluation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_evaluation_job(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob #get_evaluation_job(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob

Gets an evaluation job by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::GetEvaluationJobRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::EvaluationJob.
p result

Overloads:

  • #get_evaluation_job(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::GetEvaluationJobRequest, ::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_evaluation_job(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob

    Pass arguments to get_evaluation_job 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. Name of the evaluation job. Format:

      "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 3204

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::GetEvaluationJobRequest

  # 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
   = @config.rpcs.get_evaluation_job..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :get_evaluation_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_example(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Example #get_example(name: nil, filter: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Example

Gets an example by resource name, including both data and annotation.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::GetExampleRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::Example.
p result

Overloads:

  • #get_example(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Example

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::GetExampleRequest, ::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_example(name: nil, filter: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Example

    Pass arguments to get_example 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. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

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

      Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1748

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::GetExampleRequest

  # 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
   = @config.rpcs.get_example..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :get_example, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_instruction(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Instruction #get_instruction(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Instruction

Gets an instruction by resource name.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::GetInstructionRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::Instruction.
p result

Overloads:

  • #get_instruction(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Instruction

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::GetInstructionRequest, ::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_instruction(name: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::Instruction

    Pass arguments to get_instruction 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. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2405

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::GetInstructionRequest

  # 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
   = @config.rpcs.get_instruction..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :get_instruction, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#import_data(request, options = nil) ⇒ ::Gapic::Operation #import_data(name: nil, input_config: nil, user_email_address: nil) ⇒ ::Gapic::Operation

Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ImportDataRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #import_data(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ImportDataRequest, ::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.

  • #import_data(name: nil, input_config: nil, user_email_address: nil) ⇒ ::Gapic::Operation

    Pass arguments to import_data 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. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

    • input_config (::Google::Cloud::DataLabeling::V1beta1::InputConfig, ::Hash) (defaults to: nil)

      Required. Specify the input source of the data.

    • user_email_address (::String) (defaults to: nil)

      Email of the user who started the import task and should be notified by email. If empty no notification will be sent.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



736
737
738
739
740
741
742
743
744
745
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
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 736

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ImportDataRequest

  # 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
   = @config.rpcs.import_data..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :import_data, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#label_image(request, options = nil) ⇒ ::Gapic::Operation #label_image(image_classification_config: nil, bounding_poly_config: nil, polyline_config: nil, segmentation_config: nil, parent: nil, basic_config: nil, feature: nil) ⇒ ::Gapic::Operation

Starts a labeling task for image. The type of image labeling task is configured by feature in the request.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::LabelImageRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #label_image(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::LabelImageRequest, ::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.

  • #label_image(image_classification_config: nil, bounding_poly_config: nil, polyline_config: nil, segmentation_config: nil, parent: nil, basic_config: nil, feature: nil) ⇒ ::Gapic::Operation

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1431

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::LabelImageRequest

  # 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
   = @config.rpcs.label_image..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :label_image, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#label_text(request, options = nil) ⇒ ::Gapic::Operation #label_text(text_classification_config: nil, text_entity_extraction_config: nil, parent: nil, basic_config: nil, feature: nil) ⇒ ::Gapic::Operation

Starts a labeling task for text. The type of text labeling task is configured by feature in the request.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::LabelTextRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #label_text(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::LabelTextRequest, ::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.

  • #label_text(text_classification_config: nil, text_entity_extraction_config: nil, parent: nil, basic_config: nil, feature: nil) ⇒ ::Gapic::Operation

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1655

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::LabelTextRequest

  # 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
   = @config.rpcs.label_text..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :label_text, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#label_video(request, options = nil) ⇒ ::Gapic::Operation #label_video(video_classification_config: nil, object_detection_config: nil, object_tracking_config: nil, event_config: nil, parent: nil, basic_config: nil, feature: nil) ⇒ ::Gapic::Operation

Starts a labeling task for video. The type of video labeling task is configured by feature in the request.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::LabelVideoRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #label_video(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::LabelVideoRequest, ::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.

  • #label_video(video_classification_config: nil, object_detection_config: nil, object_tracking_config: nil, event_config: nil, parent: nil, basic_config: nil, feature: nil) ⇒ ::Gapic::Operation

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1547

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::LabelVideoRequest

  # 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
   = @config.rpcs.label_video..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :label_video, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_annotated_datasets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset> #list_annotated_datasets(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset>

Lists annotated datasets for a dataset. Pagination is supported.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ListAnnotatedDatasetsRequest.new

# Call the list_annotated_datasets method.
result = client.list_annotated_datasets 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::DataLabeling::V1beta1::AnnotatedDataset.
  p item
end

Overloads:

  • #list_annotated_datasets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ListAnnotatedDatasetsRequest, ::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_annotated_datasets(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset>

    Pass arguments to list_annotated_datasets 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. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}

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

      Optional. Filter is not supported at this moment.

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotatedDatasetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotatedDatasets] call. Return first page if empty.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1227

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ListAnnotatedDatasetsRequest

  # 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
   = @config.rpcs.list_annotated_datasets..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :list_annotated_datasets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :list_annotated_datasets, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_annotation_spec_sets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet> #list_annotation_spec_sets(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet>

Lists annotation spec sets for a project. Pagination is supported.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ListAnnotationSpecSetsRequest.new

# Call the list_annotation_spec_sets method.
result = client.list_annotation_spec_sets 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::DataLabeling::V1beta1::AnnotationSpecSet.
  p item
end

Overloads:

  • #list_annotation_spec_sets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ListAnnotationSpecSetsRequest, ::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_annotation_spec_sets(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet>

    Pass arguments to list_annotation_spec_sets 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. Parent of AnnotationSpecSet resource, format: projects/{project_id}

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

      Optional. Filter is not supported at this moment.

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotationSpecSetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotationSpecSets] call. Return first page if empty.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2133

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ListAnnotationSpecSetsRequest

  # 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
   = @config.rpcs.list_annotation_spec_sets..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :list_annotation_spec_sets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :list_annotation_spec_sets, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_data_items(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::DataItem> #list_data_items(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::DataItem>

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ListDataItemsRequest.new

# Call the list_data_items method.
result = client.list_data_items 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::DataLabeling::V1beta1::DataItem.
  p item
end

Overloads:

  • #list_data_items(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::DataItem>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ListDataItemsRequest, ::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_data_items(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::DataItem>

    Pass arguments to list_data_items 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. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

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

      Optional. Filter is not supported at this moment.

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1036

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ListDataItemsRequest

  # 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
   = @config.rpcs.list_data_items..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :list_data_items, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :list_data_items, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_datasets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Dataset> #list_datasets(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Dataset>

Lists datasets under a project. Pagination is supported.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ListDatasetsRequest.new

# Call the list_datasets method.
result = client.list_datasets 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::DataLabeling::V1beta1::Dataset.
  p item
end

Overloads:

  • #list_datasets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Dataset>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ListDatasetsRequest, ::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_datasets(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Dataset>

    Pass arguments to list_datasets 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. Dataset resource parent, format: projects/{project_id}

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

      Optional. Filter on dataset is not supported at this moment.

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by ListDatasetsResponse.next_page_token of the previous [DataLabelingService.ListDatasets] call. Returns the first page if empty.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 545

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ListDatasetsRequest

  # 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
   = @config.rpcs.list_datasets..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :list_datasets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :list_datasets, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_evaluation_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::EvaluationJob> #list_evaluation_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::EvaluationJob>

Lists all evaluation jobs within a project with possible filters. Pagination is supported.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ListEvaluationJobsRequest.new

# Call the list_evaluation_jobs method.
result = client.list_evaluation_jobs 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::DataLabeling::V1beta1::EvaluationJob.
  p item
end

Overloads:

  • #list_evaluation_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::EvaluationJob>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ListEvaluationJobsRequest, ::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_evaluation_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::EvaluationJob>

    Pass arguments to list_evaluation_jobs 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. Evaluation job resource parent. Format: "projects/{project_id}"

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

      Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluationjob.model_id = {model_name} AND evaluationjob.state = {evaluation_job_state}"

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 3580

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ListEvaluationJobsRequest

  # 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
   = @config.rpcs.list_evaluation_jobs..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :list_evaluation_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :list_evaluation_jobs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_examples(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Example> #list_examples(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Example>

Lists examples in an annotated dataset. Pagination is supported.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ListExamplesRequest.new

# Call the list_examples method.
result = client.list_examples 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::DataLabeling::V1beta1::Example.
  p item
end

Overloads:

  • #list_examples(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Example>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ListExamplesRequest, ::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_examples(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Example>

    Pass arguments to list_examples 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. Example resource parent.

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

      Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 1852

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ListExamplesRequest

  # 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
   = @config.rpcs.list_examples..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :list_examples, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :list_examples, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_instructions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Instruction> #list_instructions(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Instruction>

Lists instructions for a project. Pagination is supported.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ListInstructionsRequest.new

# Call the list_instructions method.
result = client.list_instructions 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::DataLabeling::V1beta1::Instruction.
  p item
end

Overloads:

  • #list_instructions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Instruction>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ListInstructionsRequest, ::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_instructions(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Instruction>

    Pass arguments to list_instructions 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. Instruction resource parent, format: projects/{project_id}

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

      Optional. Filter is not supported at this moment.

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by ListInstructionsResponse.next_page_token of the previous [DataLabelingService.ListInstructions] call. Return first page if empty.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2507

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ListInstructionsRequest

  # 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
   = @config.rpcs.list_instructions..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :list_instructions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :list_instructions, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#pause_evaluation_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #pause_evaluation_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pauses an evaluation job. Pausing an evaluation job that is already in a PAUSED state is a no-op.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::PauseEvaluationJobRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #pause_evaluation_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::PauseEvaluationJobRequest, ::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.

  • #pause_evaluation_job(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to pause_evaluation_job 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. Name of the evaluation job that is going to be paused. Format:

      "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 3293

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::PauseEvaluationJobRequest

  # 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
   = @config.rpcs.pause_evaluation_job..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :pause_evaluation_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#resume_evaluation_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #resume_evaluation_job(name: nil) ⇒ ::Google::Protobuf::Empty

Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::ResumeEvaluationJobRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #resume_evaluation_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::ResumeEvaluationJobRequest, ::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.

  • #resume_evaluation_job(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to resume_evaluation_job 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. Name of the evaluation job that is going to be resumed. Format:

      "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 3382

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::ResumeEvaluationJobRequest

  # 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
   = @config.rpcs.resume_evaluation_job..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :resume_evaluation_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_evaluations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Evaluation> #search_evaluations(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Evaluation>

Searches evaluations within a project.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::SearchEvaluationsRequest.new

# Call the search_evaluations method.
result = client.search_evaluations 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::DataLabeling::V1beta1::Evaluation.
  p item
end

Overloads:

  • #search_evaluations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Evaluation>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::SearchEvaluationsRequest, ::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_evaluations(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::Evaluation>

    Pass arguments to search_evaluations 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. Evaluation search parent (project ID). Format: "projects/{project_id}"

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

      Optional. To search evaluations, you can filter by the following:

      To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

      "evaluationjob.evaluation_job_id = {evaluation_job_id} AND evaluationjob.model_id = {model_name} AND evaluationjob.evaluation_job_run_time_start = {timestamp_1} AND evaluationjob.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}"

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search request.

      If you don't specify this field, the API call requests the first page of the search.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2818

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::SearchEvaluationsRequest

  # 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
   = @config.rpcs.search_evaluations..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :search_evaluations, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :search_evaluations, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_example_comparisons(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::SearchExampleComparisonsResponse::ExampleComparison> #search_example_comparisons(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::SearchExampleComparisonsResponse::ExampleComparison>

Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::SearchExampleComparisonsRequest.new

# Call the search_example_comparisons method.
result = client.search_example_comparisons 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::DataLabeling::V1beta1::SearchExampleComparisonsResponse::ExampleComparison.
  p item
end

Overloads:

  • #search_example_comparisons(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::SearchExampleComparisonsResponse::ExampleComparison>

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::SearchExampleComparisonsRequest, ::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_example_comparisons(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataLabeling::V1beta1::SearchExampleComparisonsResponse::ExampleComparison>

    Pass arguments to search_example_comparisons 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. Name of the Evaluation resource to search for example comparisons from. Format:

      "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}"

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

      Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

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

      Optional. A token identifying a page of results for the server to return. Typically obtained by the [nextPageToken][SearchExampleComparisons.next_page_token] of the response to a previous search rquest.

      If you don't specify this field, the API call requests the first page of the search.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 2925

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::SearchExampleComparisonsRequest

  # 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
   = @config.rpcs.search_example_comparisons..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :search_example_comparisons, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @data_labeling_service_stub, :search_example_comparisons, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domainString

The effective universe domain

Returns:

  • (String)


233
234
235
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 233

def universe_domain
  @data_labeling_service_stub.universe_domain
end

#update_evaluation_job(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob #update_evaluation_job(evaluation_job: nil, update_mask: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.

If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

Examples:

Basic example

require "google/cloud/data_labeling/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataLabeling::V1beta1::DataLabelingService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataLabeling::V1beta1::UpdateEvaluationJobRequest.new

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

# The returned object is of type Google::Cloud::DataLabeling::V1beta1::EvaluationJob.
p result

Overloads:

  • #update_evaluation_job(request, options = nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob

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

    Parameters:

    • request (::Google::Cloud::DataLabeling::V1beta1::UpdateEvaluationJobRequest, ::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_evaluation_job(evaluation_job: nil, update_mask: nil) ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJob

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

    • evaluation_job (::Google::Cloud::DataLabeling::V1beta1::EvaluationJob, ::Hash) (defaults to: nil)

      Required. Evaluation job that is going to be updated.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil)

      Optional. Mask for which fields to update. You can only provide the following fields:

      • evaluationJobConfig.humanAnnotationConfig.instruction
      • evaluationJobConfig.exampleCount
      • evaluationJobConfig.exampleSamplePercentage

      You can provide more than one of these fields by separating them with commas.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
# File 'lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb', line 3116

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataLabeling::V1beta1::UpdateEvaluationJobRequest

  # 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
   = @config.rpcs.update_evaluation_job..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataLabeling::V1beta1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.evaluation_job&.name
    header_params["evaluation_job.name"] = request.evaluation_job.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @data_labeling_service_stub.call_rpc :update_evaluation_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end