google-cloud-php/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.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
### YamlMime:UniversalReference
items:
  -
    uid: \Google\Cloud\Vision\V1\AnnotateFileResponse
    name: AnnotateFileResponse
    friendlyApiName: 'Cloud Vision V1 Client'
    id: AnnotateFileResponse
    summary: |-
      Response to a single file annotation request. A file may contain one or more
      images, which individually have their own responses.

      Generated from protobuf message <code>google.cloud.vision.v1.AnnotateFileResponse</code>
    type: class
    namespace: 'Google \ Cloud \ Vision \ V1'
    langs:
      - php
    children:
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::__construct()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::getInputConfig()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::hasInputConfig()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::clearInputConfig()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::setInputConfig()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::getResponses()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::setResponses()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::getTotalPages()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::setTotalPages()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::getError()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::hasError()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::clearError()'
      - '\Google\Cloud\Vision\V1\AnnotateFileResponse::setError()'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::__construct()'
    name: __construct
    id: __construct
    summary: Constructor.
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    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: 'Information about the file for which this response is generated.'
        -
          id: '↳ responses'
          var_type: 'array&lt;<xref uid="\Google\Cloud\Vision\V1\AnnotateImageResponse">AnnotateImageResponse</xref>&gt;'
          description: 'Individual responses to images found within the file. This field will be empty if the `error` field is set.'
        -
          id: '↳ total_pages'
          var_type: int
          description: 'This field gives the total number of pages in the file.'
        -
          id: '↳ error'
          var_type: '<xref uid="\Google\Rpc\Status">Google\Rpc\Status</xref>'
          description: 'If set, represents the error message for the failed request. The `responses` field will not be set in this case.'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::getInputConfig()'
    name: getInputConfig
    id: getInputConfig
    summary: 'Information about the file for which this response is generated.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Cloud\Vision\V1\InputConfig">InputConfig</xref>|null'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::hasInputConfig()'
    name: hasInputConfig
    id: hasInputConfig
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::clearInputConfig()'
    name: clearInputConfig
    id: clearInputConfig
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::setInputConfig()'
    name: setInputConfig
    id: setInputConfig
    summary: 'Information about the file for which this response is generated.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    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\AnnotateFileResponse::getResponses()'
    name: getResponses
    id: getResponses
    summary: |-
      Individual responses to images found within the file. This field will be
      empty if the `error` field is set.
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Protobuf\Internal\RepeatedField">Google\Protobuf\Internal\RepeatedField</xref>'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::setResponses()'
    name: setResponses
    id: setResponses
    summary: |-
      Individual responses to images found within the file. This field will be
      empty if the `error` field is set.
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: 'array&lt;<xref uid="\Google\Cloud\Vision\V1\AnnotateImageResponse">AnnotateImageResponse</xref>&gt;'
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::getTotalPages()'
    name: getTotalPages
    id: getTotalPages
    summary: 'This field gives the total number of pages in the file.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: int
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::setTotalPages()'
    name: setTotalPages
    id: setTotalPages
    summary: 'This field gives the total number of pages in the file.'
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: int
          description: ''
      returns:
        -
          var_type: $this
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::getError()'
    name: getError
    id: getError
    summary: |-
      If set, represents the error message for the failed request. The
      `responses` field will not be set in this case.
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
    syntax:
      returns:
        -
          var_type: '<xref uid="\Google\Rpc\Status">Google\Rpc\Status</xref>|null'
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::hasError()'
    name: hasError
    id: hasError
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::clearError()'
    name: clearError
    id: clearError
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
  -
    uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::setError()'
    name: setError
    id: setError
    summary: |-
      If set, represents the error message for the failed request. The
      `responses` field will not be set in this case.
    parent: \Google\Cloud\Vision\V1\AnnotateFileResponse
    type: method
    langs:
      - php
    syntax:
      parameters:
        -
          id: var
          var_type: '<xref uid="\Google\Rpc\Status">Google\Rpc\Status</xref>'
          description: ''
      returns:
        -
          var_type: $this