1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="datalabeling_v1beta1.html">Data Labeling API</a> . <a href="datalabeling_v1beta1.projects.html">projects</a> . <a href="datalabeling_v1beta1.projects.instructions.html">instructions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates an instruction for how data should be labeled.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes an instruction object by resource name.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets an instruction by resource name.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists instructions for a project. Pagination is supported.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 103 <pre>Creates an instruction for how data should be labeled. 104 105Args: 106 parent: string, Required. Instruction resource parent, format: projects/{project_id} (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # Request message for CreateInstruction. 111 "instruction": { # Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported. # Required. Instruction of how to perform the labeling task. 112 "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the instruction. 113 "A String", 114 ], 115 "createTime": "A String", # Output only. Creation time of instruction. 116 "csvInstruction": { # Deprecated: this instruction format is not supported any more. Instruction from a CSV file. # Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * The first column is labeled data, such as an image reference, text. * The second column is comma separated labels associated with data. 117 "gcsFileUri": "A String", # CSV file for the instruction. Only gcs path is allowed. 118 }, 119 "dataType": "A String", # Required. The data type of this instruction. 120 "description": "A String", # Optional. User-provided description of the instruction. The description can be up to 10000 characters long. 121 "displayName": "A String", # Required. The display name of the instruction. Maximum of 64 characters. 122 "name": "A String", # Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} 123 "pdfInstruction": { # Instruction from a PDF file. # Instruction from a PDF document. The PDF should be in a Cloud Storage bucket. 124 "gcsFileUri": "A String", # PDF file for the instruction. Only gcs path is allowed. 125 }, 126 "updateTime": "A String", # Output only. Last update time of instruction. 127 }, 128} 129 130 x__xgafv: string, V1 error format. 131 Allowed values 132 1 - v1 error format 133 2 - v2 error format 134 135Returns: 136 An object of the form: 137 138 { # This resource represents a long-running operation that is the result of a network API call. 139 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 140 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 141 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 142 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 143 { 144 "a_key": "", # Properties of the object. Contains field @type with type URL. 145 }, 146 ], 147 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 148 }, 149 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 150 "a_key": "", # Properties of the object. Contains field @type with type URL. 151 }, 152 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 153 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 154 "a_key": "", # Properties of the object. Contains field @type with type URL. 155 }, 156}</pre> 157</div> 158 159<div class="method"> 160 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 161 <pre>Deletes an instruction object by resource name. 162 163Args: 164 name: string, Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} (required) 165 x__xgafv: string, V1 error format. 166 Allowed values 167 1 - v1 error format 168 2 - v2 error format 169 170Returns: 171 An object of the form: 172 173 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 174}</pre> 175</div> 176 177<div class="method"> 178 <code class="details" id="get">get(name, x__xgafv=None)</code> 179 <pre>Gets an instruction by resource name. 180 181Args: 182 name: string, Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} (required) 183 x__xgafv: string, V1 error format. 184 Allowed values 185 1 - v1 error format 186 2 - v2 error format 187 188Returns: 189 An object of the form: 190 191 { # Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported. 192 "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the instruction. 193 "A String", 194 ], 195 "createTime": "A String", # Output only. Creation time of instruction. 196 "csvInstruction": { # Deprecated: this instruction format is not supported any more. Instruction from a CSV file. # Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * The first column is labeled data, such as an image reference, text. * The second column is comma separated labels associated with data. 197 "gcsFileUri": "A String", # CSV file for the instruction. Only gcs path is allowed. 198 }, 199 "dataType": "A String", # Required. The data type of this instruction. 200 "description": "A String", # Optional. User-provided description of the instruction. The description can be up to 10000 characters long. 201 "displayName": "A String", # Required. The display name of the instruction. Maximum of 64 characters. 202 "name": "A String", # Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} 203 "pdfInstruction": { # Instruction from a PDF file. # Instruction from a PDF document. The PDF should be in a Cloud Storage bucket. 204 "gcsFileUri": "A String", # PDF file for the instruction. Only gcs path is allowed. 205 }, 206 "updateTime": "A String", # Output only. Last update time of instruction. 207}</pre> 208</div> 209 210<div class="method"> 211 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 212 <pre>Lists instructions for a project. Pagination is supported. 213 214Args: 215 parent: string, Required. Instruction resource parent, format: projects/{project_id} (required) 216 filter: string, Optional. Filter is not supported at this moment. 217 pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100. 218 pageToken: string, Optional. A token identifying a page of results for the server to return. Typically obtained by ListInstructionsResponse.next_page_token of the previous [DataLabelingService.ListInstructions] call. Return first page if empty. 219 x__xgafv: string, V1 error format. 220 Allowed values 221 1 - v1 error format 222 2 - v2 error format 223 224Returns: 225 An object of the form: 226 227 { # Results of listing instructions under a project. 228 "instructions": [ # The list of Instructions to return. 229 { # Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported. 230 "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the instruction. 231 "A String", 232 ], 233 "createTime": "A String", # Output only. Creation time of instruction. 234 "csvInstruction": { # Deprecated: this instruction format is not supported any more. Instruction from a CSV file. # Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * The first column is labeled data, such as an image reference, text. * The second column is comma separated labels associated with data. 235 "gcsFileUri": "A String", # CSV file for the instruction. Only gcs path is allowed. 236 }, 237 "dataType": "A String", # Required. The data type of this instruction. 238 "description": "A String", # Optional. User-provided description of the instruction. The description can be up to 10000 characters long. 239 "displayName": "A String", # Required. The display name of the instruction. Maximum of 64 characters. 240 "name": "A String", # Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} 241 "pdfInstruction": { # Instruction from a PDF file. # Instruction from a PDF document. The PDF should be in a Cloud Storage bucket. 242 "gcsFileUri": "A String", # PDF file for the instruction. Only gcs path is allowed. 243 }, 244 "updateTime": "A String", # Output only. Last update time of instruction. 245 }, 246 ], 247 "nextPageToken": "A String", # A token to retrieve next page of results. 248}</pre> 249</div> 250 251<div class="method"> 252 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 253 <pre>Retrieves the next page of results. 254 255Args: 256 previous_request: The request for the previous page. (required) 257 previous_response: The response from the request for the previous page. (required) 258 259Returns: 260 A request object that you can call 'execute()' on to request the next 261 page. Returns None if there are no more items in the collection. 262 </pre> 263</div> 264 265</body></html>