kratos/third_party/google/cloud/automl/v1beta1/automl_gapic.yaml

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.automl.v1beta1
  python:
    package_name: google.cloud.automl_v1beta1.gapic
  go:
    package_name: cloud.google.com/go/cloud/automl/apiv1beta1
  csharp:
    package_name: Google.Cloud.Automl.V1Beta1
  ruby:
    package_name: Google::Cloud::Automl::V1Beta1
  php:
    package_name: Google\Cloud\AutoMl\V1beta1
  nodejs:
    package_name: automl.v1beta1
    domain_layer_location: google-cloud
# A list of API interface configurations.
interfaces:
  # The fully qualified name of the API interface.
- name: google.cloud.automl.v1beta1.PredictionService
  # 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}/locations/{location}/models/{model}
    entity_name: model
  # 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: 60000
    initial_rpc_timeout_millis: 60000
    rpc_timeout_multiplier: 1
    max_rpc_timeout_millis: 60000
    total_timeout_millis: 600000
  # 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: Predict
    flattening:
      groups:
      - parameters:
        - name
        - payload
        - params
    required_fields:
    - name
    - payload
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: model
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 60000
  - name: BatchPredict
    required_fields:
    - name
    - input_config
    - output_config
    flattening:
      groups:
      - parameters:
        - name
        - input_config
        - output_config
        - params
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: model
    long_running:
      return_type: google.cloud.automl.v1beta1.BatchPredictResult
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
    timeout_millis: 20000
  # The fully qualified name of the API interface.
- name: google.cloud.automl.v1beta1.AutoMl
  # 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}/locations/{location}
    entity_name: location
  - name_pattern: projects/{project}/locations/{location}/datasets/{dataset}
    entity_name: dataset
  - name_pattern: projects/{project}/locations/{location}/models/{model}
    entity_name: model
  - name_pattern: projects/{project}/locations/{location}/models/{model}/modelEvaluations/{model_evaluation}
    entity_name: model_evaluation
  - name_pattern: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}
    entity_name: annotation_spec
  - name_pattern: projects/{project}/locations/{location}/datasets/{dataset}/tableSpecs/{table_spec}
    entity_name: table_spec
  - name_pattern: projects/{project}/locations/{location}/datasets/{dataset}/tableSpecs/{table_spec}/columnSpecs/{column_spec}
    entity_name: column_spec
  # 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: 60000
    initial_rpc_timeout_millis: 20000
    rpc_timeout_multiplier: 1
    max_rpc_timeout_millis: 20000
    total_timeout_millis: 600000
  # 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: location
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
  - name: UpdateDataset
    flattening:
      groups:
      - parameters:
        - dataset
    required_fields:
    - dataset
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      dataset.name: dataset
    timeout_millis: 5000
  - name: GetDataset
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: dataset
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
  - name: ListDatasets
    flattening:
      groups:
      - parameters:
        - parent
    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: location
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
  - name: DeleteDataset
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: dataset
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
    long_running:
      return_type: google.protobuf.Empty
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
  - 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
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
    long_running:
      return_type: google.protobuf.Empty
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
  - name: ExportData
    flattening:
      groups:
      - parameters:
        - name
        - output_config
    required_fields:
    - name
    - output_config
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: dataset
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
    long_running:
      return_type: google.protobuf.Empty
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
  - name: CreateModel
    flattening:
      groups:
      - parameters:
        - parent
        - model
    required_fields:
    - parent
    - model
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      parent: location
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
    long_running:
      return_type: google.cloud.automl.v1beta1.Model
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
  - name: GetModel
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: model
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
  - name: ListModels
    flattening:
      groups:
      - parameters:
        - parent
    required_fields:
    - parent
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: model
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      parent: location
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
  - name: DeleteModel
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: model
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
    long_running:
      return_type: google.protobuf.Empty
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
  - name: DeployModel
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: model
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
    long_running:
      return_type: google.protobuf.Empty
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
  - name: UndeployModel
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: model
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
    long_running:
      return_type: google.protobuf.Empty
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
  - name: GetModelEvaluation
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: model_evaluation
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
  - name: ExportModel
    required_fields:
    - name
    - output_config
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: model
    long_running:
      return_type: google.protobuf.Empty
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
    timeout_millis: 5000
  - name: ExportEvaluatedExamples
    required_fields:
    - name
    - output_config
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: model
    long_running:
      return_type: google.protobuf.Empty
      metadata_type: google.cloud.automl.v1beta1.OperationMetadata
      initial_poll_delay_millis: 500
      poll_delay_multiplier: 1.5
      max_poll_delay_millis: 5000
      total_poll_timeout_millis: 300000
    timeout_millis: 5000
  - name: ListModelEvaluations
    flattening:
      groups:
      - parameters:
        - parent
    required_fields:
    - parent
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: model_evaluation
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      parent: model
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 5000
  - name: GetAnnotationSpec
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: annotation_spec
    timeout_millis: 5000
  - name: GetTableSpec
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: table_spec
    timeout_millis: 5000
  - name: ListTableSpecs
    flattening:
      groups:
      - parameters:
        - parent
    required_fields:
    - parent
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: table_specs
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      parent: dataset
    timeout_millis: 5000
  - name: UpdateTableSpec
    flattening:
      groups:
      - parameters:
        - table_spec
    required_fields:
    - table_spec
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      table_spec.name: table_spec
    timeout_millis: 5000
  - name: GetColumnSpec
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: column_spec
    timeout_millis: 5000
  - name: ListColumnSpecs
    flattening:
      groups:
      - parameters:
        - parent
    required_fields:
    - parent
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: column_specs
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      parent: table_spec
    timeout_millis: 5000
  - name: UpdateColumnSpec
    flattening:
      groups:
      - parameters:
        - column_spec
    required_fields:
    - column_spec
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      column_spec.name: column_spec
    timeout_millis: 5000
resource_name_generation:
- message_name: CreateDatasetRequest
  field_entity_map:
    parent: location
- message_name: UpdateDatasetRequest
  field_entity_map:
    dataset.name: dataset
- message_name: GetDatasetRequest
  field_entity_map:
    name: dataset
- message_name: ListDatasetsRequest
  field_entity_map:
    parent: location
- message_name: DeleteDatasetRequest
  field_entity_map:
    name: dataset
- message_name: ImportDataRequest
  field_entity_map:
    name: dataset
- message_name: ExportDataRequest
  field_entity_map:
    name: dataset
- message_name: CreateModelRequest
  field_entity_map:
    parent: location
- message_name: GetModelRequest
  field_entity_map:
    name: model
- message_name: ListModelsRequest
  field_entity_map:
    parent: location
- message_name: DeleteModelRequest
  field_entity_map:
    name: model
- message_name: DeployModelRequest
  field_entity_map:
    name: model
- message_name: UndeployModelRequest
  field_entity_map:
    name: model
- message_name: ExportModelRequest
  field_entity_map:
    name: model
- message_name: ExportEvaluatedExamplesRequest
  field_entity_map:
    name: model
- message_name: GetModelEvaluationRequest
  field_entity_map:
    name: model_evaluation
- message_name: ListModelEvaluationsRequest
  field_entity_map:
    parent: model
- message_name: PredictRequest
  field_entity_map:
    name: model
- message_name: BatchPredictRequest
  field_entity_map:
    name: model
- message_name: GetAnnotationSpecRequest
  field_entity_map:
    name: annotation_spec
- message_name: GetTableSpecRequest
  field_entity_map:
    name: table_spec
- message_name: ListTableSpecsRequest
  field_entity_map:
    parent: dataset
- message_name: UpdateTableSpecRequest
  field_entity_map:
    table_spec.name: table_spec
- message_name: GetColumnSpecRequest
  field_entity_map:
    name: column_spec
- message_name: ListColumnSpecsRequest
  field_entity_map:
    parent: table_spec
- message_name: UpdateColumnSpecRequest
  field_entity_map:
    column_spec.name: column_spec