kratos/third_party/google/cloud/resourcemanager/v2/cloudresourcemanager_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.resourcemanager.v2
  python:
    package_name: google.cloud.resourcemanager_v2.gapic
  go:
    package_name: cloud.google.com/go/resourcemanager/apiv2
  csharp:
    package_name: Google.Cloud.ResourceManager.V2
  ruby:
    package_name: Google::Cloud::ResourceManager::V2
  php:
    package_name: Google\Cloud\ResourceManager\V2
  nodejs:
    package_name: resourcemanager.v2
    domain_layer_location: google-cloud
collection_oneofs:
- oneof_name: parent_oneof
  collection_names:
  - organization
  - folder
# A list of API interface configurations.
interfaces:
  # The fully qualified name of the API interface.
- name: google.cloud.resourcemanager.v2.Folders
  # 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: folders/{folder}
    entity_name: folder
  - name_pattern: organizations/{org_id}
    entity_name: organization
  # Definition for smoke test.
  smoke_test:
    method: SearchFolders
    init_fields:
    - query=""  # Returns all folders that the caller has access to.
  # 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: 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: ListFolders
    flattening:
      groups:
      - parameters:
        - parent
        - show_deleted
      - 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: folders
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      parent: parent_oneof
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 30000
  - name: SearchFolders
    flattening:
      groups:
      - parameters:
        - query
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: folders
    retry_codes_name: idempotent
    retry_params_name: default
    timeout_millis: 30000
  - name: GetFolder
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: folder
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 30000
  - name: CreateFolder
    flattening:
      groups:
      - parameters:
        - parent
        - folder
    required_fields:
    - parent
    - folder
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      parent: parent_oneof
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 30000
  - name: UpdateFolder
    flattening:
      groups:
      - parameters:
        - folder
        - update_mask
    required_fields:
    - folder
    - update_mask
    retry_codes_name: non_idempotent
    retry_params_name: default
    timeout_millis: 30000
  - name: MoveFolder
    flattening:
      groups:
      - parameters:
        - name
        - destination_parent
    required_fields:
    - name
    - destination_parent
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: folder
      destination_parent: parent_oneof
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 30000
  - name: DeleteFolder
    flattening:
      groups:
      - parameters:
        - name
      - parameters:
        - name
        - recursive_delete
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: folder
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 30000
  - name: UndeleteFolder
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: folder
    resource_name_treatment: STATIC_TYPES
    timeout_millis: 30000
  - name: GetIamPolicy
    flattening:
      groups:
      - parameters:
        - resource
    required_fields:
    - resource
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      resource: folder
    timeout_millis: 30000
  - name: SetIamPolicy
    flattening:
      groups:
      - parameters:
        - resource
        - policy
    required_fields:
    - resource
    - policy
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      resource: folder
    timeout_millis: 30000
  - name: TestIamPermissions
    flattening:
      groups:
      - parameters:
        - resource
        - permissions
    required_fields:
    - resource
    - permissions
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      resource: folder
    timeout_millis: 30000
resource_name_generation:
- message_name: ListFoldersRequest
  field_entity_map:
    parent: parent_oneof
- message_name: GetFolderRequest
  field_entity_map:
    name: folder
- message_name: CreateFolderRequest
  field_entity_map:
    parent: parent_oneof
- message_name: MoveFolderRequest
  field_entity_map:
    name: folder
    destination_parent: parent_oneof
- message_name: DeleteFolderRequest
  field_entity_map:
    name: folder
- message_name: UndeleteFolderRequest
  field_entity_map:
    name: folder
- message_name: Folder
  field_entity_map:
    name: folder
    parent: parent_oneof