aboutsummaryrefslogtreecommitdiff
path: root/google/firestore/admin/v1/firestore_gapic.yaml
blob: 90f2189c2cb17a0b0af61601b4099f16812fcf3d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
type: com.google.api.codegen.ConfigProto
config_schema_version: 1.0.0
language_settings:
  java:
    package_name: com.google.cloud.firestore.v1
  python:
    package_name: google.cloud.firestore_v1.gapic
  go:
    package_name: cloud.google.com/go/firestore/apiv1
    domain_layer_location: cloud.google.com/go/firestore
  csharp:
    package_name: Google.Cloud.Firestore.V1
  ruby:
    package_name: Google::Cloud::Firestore::V1
  php:
    package_name: Google\Cloud\Firestore\V1
  nodejs:
    package_name: firestore.v1
    domain_layer_location: google-cloud
interfaces:
- name: google.firestore.admin.v1.FirestoreAdmin
  collections:
  - name_pattern: projects/{project}/databases/{database}
    entity_name: database
  - name_pattern: projects/{project}/databases/{database}/collectionGroups/{collection_id}
    entity_name: parent
  - name_pattern: projects/{project}/databases/{database}/collectionGroups/{collection_id}/indexes/{index_id}
    entity_name: index
  - name_pattern: projects/{project}/databases/{database}/collectionGroups/{collection_id}/fields/{field_id}
    entity_name: field
  retry_codes_def:
  - name: idempotent
    retry_codes:
    - UNAVAILABLE
    - DEADLINE_EXCEEDED
  - name: non_idempotent
    retry_codes: []
  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
  methods:
  - name: CreateIndex
    flattening:
      groups:
      - parameters:
        - parent
        - index
    required_fields:
    - parent
    - index
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      parent: parent
    timeout_millis: 60000
  - name: ListIndexes
    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: indexes
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      parent: parent
    timeout_millis: 60000
  - name: GetIndex
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: index
    timeout_millis: 60000
    resource_name_treatment: STATIC_TYPES
  - name: DeleteIndex
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: index
    timeout_millis: 60000
    resource_name_treatment: STATIC_TYPES
  - name: ImportDocuments
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: database
    timeout_millis: 60000
    resource_name_treatment: STATIC_TYPES
  - name: ExportDocuments
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: non_idempotent
    retry_params_name: default
    field_name_patterns:
      name: database
    timeout_millis: 60000
    resource_name_treatment: STATIC_TYPES
  - name: GetField
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: field
    timeout_millis: 60000
    resource_name_treatment: STATIC_TYPES
  - name: ListFields
    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: fields
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      parent: parent
    timeout_millis: 60000
  - name: UpdateField
    flattening:
      groups:
      - parameters:
        - field
    required_fields:
    - field
    retry_codes_name: non_idempotent
    retry_params_name: default
    timeout_millis: 60000
resource_name_generation:
- message_name: GetIndexRequest
  field_entity_map:
    name: index
- message_name: DeleteIndexRequest
  field_entity_map:
    name: index
- message_name: ImportDocumentsRequest
  field_entity_map:
    name: database
- message_name: ExportDocumentsRequest
  field_entity_map:
    name: database
- message_name: GetFieldRequest
  field_entity_map:
    name: field