google-cloud-php/dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml at ea54e7756779b9a04f43bc760640fb70b8dab2c3 · googleapis/google-cloud-php · GitHub

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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
### YamlMime:UniversalReference
items:
  -
    uid: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    name: AsyncBatchAnnotateImagesRequest
    friendlyApiName: 'Cloud Vision V1 Client'
    id: AsyncBatchAnnotateImagesRequest
    summary: |-
      Request for async image annotation for a list of images.

      Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest</code>
    type: class
    namespace: 'Google \ Cloud \ Vision \ V1'
    langs:
      - php
    children:
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::__construct()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getRequests()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setRequests()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getOutputConfig()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::hasOutputConfig()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::clearOutputConfig()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setOutputConfig()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getParent()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setParent()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getLabels()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setLabels()'
      - '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::build()'
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::__construct()'
    name: __construct
    id: __construct
    summary: Constructor.
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: data
          var_type: array
          description: 'Optional. Data for populating the Message object.'
        -
          id: '↳ requests'
          var_type: 'array&lt;<xref uid="\Google\Cloud\Vision\V1\AnnotateImageRequest">AnnotateImageRequest</xref>&gt;'
          description: 'Required. Individual image annotation requests for this batch.'
        -
          id: '↳ output_config'
          var_type: '<xref uid="\Google\Cloud\Vision\V1\OutputConfig">OutputConfig</xref>'
          description: 'Required. The desired output location and metadata (e.g. format).'
        -
          id: '↳ parent'
          var_type: string
          description: 'Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.'
        -
          id: '↳ labels'
          var_type: 'array|<xref uid="\Google\Protobuf\Internal\MapField">Google\Protobuf\Internal\MapField</xref>'
          description: 'Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.'
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getRequests()'
    name: getRequests
    id: getRequests
    summary: 'Required. Individual image annotation requests for this batch.'
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Protobuf\Internal\RepeatedField">Google\Protobuf\Internal\RepeatedField</xref>'
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setRequests()'
    name: setRequests
    id: setRequests
    summary: 'Required. Individual image annotation requests for this batch.'
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: 'array&lt;<xref uid="\Google\Cloud\Vision\V1\AnnotateImageRequest">AnnotateImageRequest</xref>&gt;'
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getOutputConfig()'
    name: getOutputConfig
    id: getOutputConfig
    summary: 'Required. The desired output location and metadata (e.g. format).'
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Cloud\Vision\V1\OutputConfig">OutputConfig</xref>|null'
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::hasOutputConfig()'
    name: hasOutputConfig
    id: hasOutputConfig
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::clearOutputConfig()'
    name: clearOutputConfig
    id: clearOutputConfig
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setOutputConfig()'
    name: setOutputConfig
    id: setOutputConfig
    summary: 'Required. The desired output location and metadata (e.g. format).'
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: '<xref uid="\Google\Cloud\Vision\V1\OutputConfig">OutputConfig</xref>'
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getParent()'
    name: getParent
    id: getParent
    summary: |-
      Optional. Target project and location to make a call.

      Format: `projects/{project-id}/locations/{location-id}`.
      If no parent is specified, a region will be chosen automatically.
      Supported location-ids:
          `us`: USA country only,
          `asia`: East asia areas, like Japan, Taiwan,
          `eu`: The European Union.
      Example: `projects/project-A/locations/eu`.
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: string
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setParent()'
    name: setParent
    id: setParent
    summary: |-
      Optional. Target project and location to make a call.

      Format: `projects/{project-id}/locations/{location-id}`.
      If no parent is specified, a region will be chosen automatically.
      Supported location-ids:
          `us`: USA country only,
          `asia`: East asia areas, like Japan, Taiwan,
          `eu`: The European Union.
      Example: `projects/project-A/locations/eu`.
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: string
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::getLabels()'
    name: getLabels
    id: getLabels
    summary: |-
      Optional. The labels with user-defined metadata for the request.

      Label keys and values can be no longer than 63 characters
      (Unicode codepoints), can only contain lowercase letters, numeric
      characters, underscores and dashes. International characters are allowed.
      Label values are optional. Label keys must start with a letter.
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Protobuf\Internal\MapField">Google\Protobuf\Internal\MapField</xref>'
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::setLabels()'
    name: setLabels
    id: setLabels
    summary: |-
      Optional. The labels with user-defined metadata for the request.

      Label keys and values can be no longer than 63 characters
      (Unicode codepoints), can only contain lowercase letters, numeric
      characters, underscores and dashes. International characters are allowed.
      Label values are optional. Label keys must start with a letter.
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: 'array|<xref uid="\Google\Protobuf\Internal\MapField">Google\Protobuf\Internal\MapField</xref>'
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest::build()'
    name: 'static::build'
    id: build
    parent: \Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: requests
          var_type: 'array&lt;<xref uid="\Google\Cloud\Vision\V1\AnnotateImageRequest">AnnotateImageRequest</xref>&gt;'
          description: 'Required. Individual image annotation requests for this batch.'
        -
          id: outputConfig
          var_type: '<xref uid="\Google\Cloud\Vision\V1\OutputConfig">OutputConfig</xref>'
          description: 'Required. The desired output location and metadata (e.g. format).'
      returns:
        -
          var_type: '<xref uid="\Google\Cloud\Vision\V1\AsyncBatchAnnotateImagesRequest">AsyncBatchAnnotateImagesRequest</xref>'