google-cloud-php/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileRequest.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
### YamlMime:UniversalReference
items:
  -
    uid: \Google\Cloud\Vision\V1\AnnotateFileRequest
    name: AnnotateFileRequest
    friendlyApiName: 'Cloud Vision V1 Client'
    id: AnnotateFileRequest
    summary: |-
      A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

      Generated from protobuf message <code>google.cloud.vision.v1.AnnotateFileRequest</code>
    type: class
    namespace: 'Google \ Cloud \ Vision \ V1'
    langs:
      - php
    children:
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::__construct()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::getInputConfig()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::hasInputConfig()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::clearInputConfig()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::setInputConfig()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::getFeatures()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::setFeatures()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::getImageContext()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::hasImageContext()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::clearImageContext()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::setImageContext()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::getPages()'
      - '\Google\Cloud\Vision\V1\AnnotateFileRequest::setPages()'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::__construct()'
    name: __construct
    id: __construct
    summary: Constructor.
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: data
          var_type: array
          description: 'Optional. Data for populating the Message object.'
        -
          id: '↳ input_config'
          var_type: '<xref uid="\Google\Cloud\Vision\V1\InputConfig">InputConfig</xref>'
          description: 'Required. Information about the input file.'
        -
          id: '↳ features'
          var_type: 'array&lt;<xref uid="\Google\Cloud\Vision\V1\Feature">Feature</xref>&gt;'
          description: 'Required. Requested features.'
        -
          id: '↳ image_context'
          var_type: '<xref uid="\Google\Cloud\Vision\V1\ImageContext">ImageContext</xref>'
          description: 'Additional context that may accompany the image(s) in the file.'
        -
          id: '↳ pages'
          var_type: array<int>
          description: 'Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::getInputConfig()'
    name: getInputConfig
    id: getInputConfig
    summary: 'Required. Information about the input file.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Cloud\Vision\V1\InputConfig">InputConfig</xref>|null'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::hasInputConfig()'
    name: hasInputConfig
    id: hasInputConfig
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::clearInputConfig()'
    name: clearInputConfig
    id: clearInputConfig
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::setInputConfig()'
    name: setInputConfig
    id: setInputConfig
    summary: 'Required. Information about the input file.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: '<xref uid="\Google\Cloud\Vision\V1\InputConfig">InputConfig</xref>'
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::getFeatures()'
    name: getFeatures
    id: getFeatures
    summary: 'Required. Requested features.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Protobuf\Internal\RepeatedField">Google\Protobuf\Internal\RepeatedField</xref>'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::setFeatures()'
    name: setFeatures
    id: setFeatures
    summary: 'Required. Requested features.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: 'array&lt;<xref uid="\Google\Cloud\Vision\V1\Feature">Feature</xref>&gt;'
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::getImageContext()'
    name: getImageContext
    id: getImageContext
    summary: 'Additional context that may accompany the image(s) in the file.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Cloud\Vision\V1\ImageContext">ImageContext</xref>|null'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::hasImageContext()'
    name: hasImageContext
    id: hasImageContext
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::clearImageContext()'
    name: clearImageContext
    id: clearImageContext
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::setImageContext()'
    name: setImageContext
    id: setImageContext
    summary: 'Additional context that may accompany the image(s) in the file.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: '<xref uid="\Google\Cloud\Vision\V1\ImageContext">ImageContext</xref>'
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::getPages()'
    name: getPages
    id: getPages
    summary: |-
      Pages of the file to perform image annotation.

      Pages starts from 1, we assume the first page of the file is page 1.
      At most 5 pages are supported per request. Pages can be negative.
      Page 1 means the first page.
      Page 2 means the second page.
      Page -1 means the last page.
      Page -2 means the second to the last page.
      If the file is GIF instead of PDF or TIFF, page refers to GIF frames.
      If this field is empty, by default the service performs image annotation
      for the first 5 pages of the file.
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Protobuf\Internal\RepeatedField">Google\Protobuf\Internal\RepeatedField</xref>'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileRequest::setPages()'
    name: setPages
    id: setPages
    summary: |-
      Pages of the file to perform image annotation.

      Pages starts from 1, we assume the first page of the file is page 1.
      At most 5 pages are supported per request. Pages can be negative.
      Page 1 means the first page.
      Page 2 means the second page.
      Page -1 means the last page.
      Page -2 means the second to the last page.
      If the file is GIF instead of PDF or TIFF, page refers to GIF frames.
      If this field is empty, by default the service performs image annotation
      for the first 5 pages of the file.
    parent: \Google\Cloud\Vision\V1\AnnotateFileRequest
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: 'int[]'
          description: ''
      returns:
        -
          var_type: $this