| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <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> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates an instruction for how data should be labeled.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes an instruction object by resource name.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets an instruction by resource name.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists instructions for a project. Pagination is supported.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next()</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> | |
| <pre>Creates an instruction for how data should be labeled. | |
| Args: | |
| parent: string, Required. Instruction resource parent, format: projects/{project_id} (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Request message for CreateInstruction. | |
| "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. | |
| "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the instruction. | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Creation time of instruction. | |
| "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. | |
| "gcsFileUri": "A String", # CSV file for the instruction. Only gcs path is allowed. | |
| }, | |
| "dataType": "A String", # Required. The data type of this instruction. | |
| "description": "A String", # Optional. User-provided description of the instruction. The description can be up to 10000 characters long. | |
| "displayName": "A String", # Required. The display name of the instruction. Maximum of 64 characters. | |
| "name": "A String", # Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} | |
| "pdfInstruction": { # Instruction from a PDF file. # Instruction from a PDF document. The PDF should be in a Cloud Storage bucket. | |
| "gcsFileUri": "A String", # PDF file for the instruction. Only gcs path is allowed. | |
| }, | |
| "updateTime": "A String", # Output only. Last update time of instruction. | |
| }, | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "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. | |
| "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. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "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. | |
| }, | |
| "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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "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}`. | |
| "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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> | |
| <pre>Deletes an instruction object by resource name. | |
| Args: | |
| name: string, Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # 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); } | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>Gets an instruction by resource name. | |
| Args: | |
| name: string, Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported. | |
| "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the instruction. | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Creation time of instruction. | |
| "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. | |
| "gcsFileUri": "A String", # CSV file for the instruction. Only gcs path is allowed. | |
| }, | |
| "dataType": "A String", # Required. The data type of this instruction. | |
| "description": "A String", # Optional. User-provided description of the instruction. The description can be up to 10000 characters long. | |
| "displayName": "A String", # Required. The display name of the instruction. Maximum of 64 characters. | |
| "name": "A String", # Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} | |
| "pdfInstruction": { # Instruction from a PDF file. # Instruction from a PDF document. The PDF should be in a Cloud Storage bucket. | |
| "gcsFileUri": "A String", # PDF file for the instruction. Only gcs path is allowed. | |
| }, | |
| "updateTime": "A String", # Output only. Last update time of instruction. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Lists instructions for a project. Pagination is supported. | |
| Args: | |
| parent: string, Required. Instruction resource parent, format: projects/{project_id} (required) | |
| filter: string, Optional. Filter is not supported at this moment. | |
| pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100. | |
| 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. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Results of listing instructions under a project. | |
| "instructions": [ # The list of Instructions to return. | |
| { # Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported. | |
| "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the instruction. | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Creation time of instruction. | |
| "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. | |
| "gcsFileUri": "A String", # CSV file for the instruction. Only gcs path is allowed. | |
| }, | |
| "dataType": "A String", # Required. The data type of this instruction. | |
| "description": "A String", # Optional. User-provided description of the instruction. The description can be up to 10000 characters long. | |
| "displayName": "A String", # Required. The display name of the instruction. Maximum of 64 characters. | |
| "name": "A String", # Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} | |
| "pdfInstruction": { # Instruction from a PDF file. # Instruction from a PDF document. The PDF should be in a Cloud Storage bucket. | |
| "gcsFileUri": "A String", # PDF file for the instruction. Only gcs path is allowed. | |
| }, | |
| "updateTime": "A String", # Output only. Last update time of instruction. | |
| }, | |
| ], | |
| "nextPageToken": "A String", # A token to retrieve next page of results. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next()</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| </body></html> |