You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kratos/third_party/google/cloud/datalabeling/v1beta1/datalabeling_gapic.yaml

540 lines
16 KiB

type: com.google.api.codegen.ConfigProto
config_schema_version: 1.0.0
# The settings of generated code in a specific language.
language_settings:
java:
package_name: com.google.cloud.datalabeling.v1beta1
python:
package_name: google.cloud.datalabeling_v1beta1.gapic
go:
package_name: cloud.google.com/go/datalabeling/apiv1beta1
csharp:
package_name: Google.Cloud.Datalabeling.V1beta1
ruby:
package_name: Google::Cloud::Datalabeling::V1beta1
php:
package_name: Google\Cloud\Datalabeling\V1beta1
nodejs:
package_name: datalabeling.v1beta1
domain_layer_location: google-cloud
# The configuration for the license header to put on generated files.
license_header:
# The file containing the raw license header without any copyright line(s).
license_file: license-header-apache-2.0.txt
# A list of API interface configurations.
interfaces:
# The fully qualified name of the API interface.
- name: google.cloud.datalabeling.v1beta1.DataLabelingService
# A list of resource collection configurations.
# Consists of a name_pattern and an entity_name.
# The name_pattern is a pattern to describe the names of the resources of this
# collection, using the platform's conventions for URI patterns. A generator
# may use this to generate methods to compose and decompose such names. The
# pattern should use named placeholders as in `shelves/{shelf}/books/{book}`;
# those will be taken as hints for the parameter names of the generated
# methods. If empty, no name methods are generated.
# The entity_name is the name to be used as a basis for generated methods and
# classes.
collections:
- name_pattern: projects/{project}
entity_name: project
- name_pattern: projects/{project}/annotationSpecSets/{annotation_spec_set}
entity_name: annotation_spec_set
- name_pattern: projects/{project}/datasets/{dataset}
entity_name: dataset
- name_pattern: projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}
entity_name: annotated_dataset
- name_pattern: projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}/examples/{example}
entity_name: example
- name_pattern: projects/{project}/datasets/{dataset}/dataItems/{data_item}
entity_name: data_item
- name_pattern: projects/{project}/instructions/{instruction}
entity_name: instruction
# Definition for retryable codes.
retry_codes_def:
- name: idempotent
retry_codes:
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 30000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 300000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: CreateDataset
flattening:
groups:
- parameters:
- parent
- dataset
required_fields:
- parent
- dataset
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 30000
- name: GetDataset
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: dataset
timeout_millis: 30000
- name: ListDatasets
flattening:
groups:
- parameters:
- parent
- filter
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: datasets
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 30000
- name: DeleteDataset
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: dataset
timeout_millis: 30000
- name: ImportData
flattening:
groups:
- parameters:
- name
- input_config
required_fields:
- name
- input_config
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: dataset
long_running:
return_type: google.cloud.datalabeling.v1beta1.ImportDataOperationResponse
metadata_type: google.cloud.datalabeling.v1beta1.ImportDataOperationMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 30000
- name: ExportData
flattening:
groups:
- parameters:
- name
- annotated_dataset
- filter
- output_config
required_fields:
- name
- annotated_dataset
- output_config
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: dataset
long_running:
return_type: google.cloud.datalabeling.v1beta1.ExportDataOperationResponse
metadata_type: google.cloud.datalabeling.v1beta1.ExportDataOperationMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 30000
- name: GetDataItem
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: data_item
timeout_millis: 30000
- name: ListDataItems
flattening:
groups:
- parameters:
- parent
- filter
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: data_items
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: dataset
timeout_millis: 30000
- name: GetAnnotatedDataset
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: annotated_dataset
timeout_millis: 30000
- name: ListAnnotatedDatasets
flattening:
groups:
- parameters:
- parent
- filter
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: annotated_datasets
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: dataset
timeout_millis: 30000
- name: LabelImage
flattening:
groups:
- parameters:
- parent
- basic_config
- feature
required_fields:
- parent
- basic_config
- feature
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: dataset
long_running:
return_type: google.cloud.datalabeling.v1beta1.AnnotatedDataset
metadata_type: google.cloud.datalabeling.v1beta1.LabelOperationMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 30000
- name: LabelVideo
flattening:
groups:
- parameters:
- parent
- basic_config
- feature
required_fields:
- parent
- basic_config
- feature
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: dataset
long_running:
return_type: google.cloud.datalabeling.v1beta1.AnnotatedDataset
metadata_type: google.cloud.datalabeling.v1beta1.LabelOperationMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 30000
- name: LabelText
flattening:
groups:
- parameters:
- parent
- basic_config
- feature
required_fields:
- parent
- basic_config
- feature
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: dataset
long_running:
return_type: google.cloud.datalabeling.v1beta1.AnnotatedDataset
metadata_type: google.cloud.datalabeling.v1beta1.LabelOperationMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 30000
- name: LabelAudio
flattening:
groups:
- parameters:
- parent
- basic_config
- feature
required_fields:
- parent
- basic_config
- feature
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: dataset
long_running:
return_type: google.cloud.datalabeling.v1beta1.AnnotatedDataset
metadata_type: google.cloud.datalabeling.v1beta1.LabelOperationMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 30000
- name: GetExample
flattening:
groups:
- parameters:
- name
- filter
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: example
timeout_millis: 30000
- name: ListExamples
flattening:
groups:
- parameters:
- parent
- filter
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: examples
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: annotated_dataset
timeout_millis: 30000
- name: CreateAnnotationSpecSet
flattening:
groups:
- parameters:
- parent
- annotation_spec_set
required_fields:
- parent
- annotation_spec_set
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 30000
- name: GetAnnotationSpecSet
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: annotation_spec_set
timeout_millis: 30000
- name: ListAnnotationSpecSets
flattening:
groups:
- parameters:
- parent
- filter
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: annotation_spec_sets
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 30000
- name: DeleteAnnotationSpecSet
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: annotation_spec_set
timeout_millis: 30000
- name: CreateInstruction
flattening:
groups:
- parameters:
- parent
- instruction
required_fields:
- parent
- instruction
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
long_running:
return_type: google.cloud.datalabeling.v1beta1.Instruction
metadata_type: google.cloud.datalabeling.v1beta1.CreateInstructionMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 30000
- name: GetInstruction
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: instruction
timeout_millis: 30000
- name: ListInstructions
flattening:
groups:
- parameters:
- parent
- filter
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: instructions
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 30000
- name: DeleteInstruction
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: instruction
timeout_millis: 30000