| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.datasets.html">datasets</a> . <a href="datalabeling_v1beta1.projects.datasets.annotatedDatasets.html">annotatedDatasets</a> . <a href="datalabeling_v1beta1.projects.datasets.annotatedDatasets.feedbackThreads.html">feedbackThreads</a> . <a href="datalabeling_v1beta1.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.html">feedbackMessages</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">Create a FeedbackMessage object.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Delete a FeedbackMessage.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Get a FeedbackMessage object.</p> |
| 89 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 91 | <p class="firstline">List FeedbackMessages with pagination.</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>Create a FeedbackMessage object. |
| 104 | |
| 105 | Args: |
| 106 | parent: string, Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}. (required) |
| 107 | body: object, The request body. |
| 108 | The object takes the form of: |
| 109 | |
| 110 | { # A feedback message inside a feedback thread. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 111 | "body": "A String", # String content of the feedback. Maximum of 10000 characters. |
| 112 | "createTime": "A String", # Create time. |
| 113 | "image": "A String", # The image storing this feedback if the feedback is an image representing operator's comments. |
| 114 | "name": "A String", # Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}' |
| 115 | "operatorFeedbackMetadata": { # Metadata describing the feedback from the operator. |
| 116 | }, |
| 117 | "requesterFeedbackMetadata": { # Metadata describing the feedback from the labeling task requester. |
| 118 | }, |
| 119 | } |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 120 | |
| 121 | x__xgafv: string, V1 error format. |
| 122 | Allowed values |
| 123 | 1 - v1 error format |
| 124 | 2 - v2 error format |
| 125 | |
| 126 | Returns: |
| 127 | An object of the form: |
| 128 | |
| 129 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 130 | "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. |
| 131 | "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. |
| 132 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 133 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 134 | { |
| 135 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 136 | }, |
| 137 | ], |
| 138 | "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. |
| 139 | }, |
| 140 | "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. |
| 141 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 142 | }, |
| 143 | "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}`. |
| 144 | "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`. |
| 145 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 146 | }, |
| 147 | }</pre> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 148 | </div> |
| 149 | |
| 150 | <div class="method"> |
| 151 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 152 | <pre>Delete a FeedbackMessage. |
| 153 | |
| 154 | Args: |
| 155 | name: string, Required. Name of the FeedbackMessage that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'. (required) |
| 156 | x__xgafv: string, V1 error format. |
| 157 | Allowed values |
| 158 | 1 - v1 error format |
| 159 | 2 - v2 error format |
| 160 | |
| 161 | Returns: |
| 162 | An object of the form: |
| 163 | |
| 164 | { # 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 `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 165 | }</pre> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 166 | </div> |
| 167 | |
| 168 | <div class="method"> |
| 169 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 170 | <pre>Get a FeedbackMessage object. |
| 171 | |
| 172 | Args: |
| 173 | name: string, Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'. (required) |
| 174 | x__xgafv: string, V1 error format. |
| 175 | Allowed values |
| 176 | 1 - v1 error format |
| 177 | 2 - v2 error format |
| 178 | |
| 179 | Returns: |
| 180 | An object of the form: |
| 181 | |
| 182 | { # A feedback message inside a feedback thread. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 183 | "body": "A String", # String content of the feedback. Maximum of 10000 characters. |
| 184 | "createTime": "A String", # Create time. |
| 185 | "image": "A String", # The image storing this feedback if the feedback is an image representing operator's comments. |
| 186 | "name": "A String", # Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}' |
| 187 | "operatorFeedbackMetadata": { # Metadata describing the feedback from the operator. |
| 188 | }, |
| 189 | "requesterFeedbackMetadata": { # Metadata describing the feedback from the labeling task requester. |
| 190 | }, |
| 191 | }</pre> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 192 | </div> |
| 193 | |
| 194 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 195 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 196 | <pre>List FeedbackMessages with pagination. |
| 197 | |
| 198 | Args: |
| 199 | parent: string, Required. FeedbackMessage resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}" (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 200 | pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 201 | pageToken: string, Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackMessages.next_page_token of the previous [DataLabelingService.ListFeedbackMessages] call. Return first page if empty. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 202 | x__xgafv: string, V1 error format. |
| 203 | Allowed values |
| 204 | 1 - v1 error format |
| 205 | 2 - v2 error format |
| 206 | |
| 207 | Returns: |
| 208 | An object of the form: |
| 209 | |
| 210 | { # Results for listing FeedbackMessages. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 211 | "feedbackMessages": [ # The list of feedback messages to return. |
| 212 | { # A feedback message inside a feedback thread. |
| 213 | "body": "A String", # String content of the feedback. Maximum of 10000 characters. |
| 214 | "createTime": "A String", # Create time. |
| 215 | "image": "A String", # The image storing this feedback if the feedback is an image representing operator's comments. |
| 216 | "name": "A String", # Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}' |
| 217 | "operatorFeedbackMetadata": { # Metadata describing the feedback from the operator. |
| 218 | }, |
| 219 | "requesterFeedbackMetadata": { # Metadata describing the feedback from the labeling task requester. |
| 220 | }, |
| 221 | }, |
| 222 | ], |
| 223 | "nextPageToken": "A String", # A token to retrieve next page of results. |
| 224 | }</pre> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 225 | </div> |
| 226 | |
| 227 | <div class="method"> |
| 228 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 229 | <pre>Retrieves the next page of results. |
| 230 | |
| 231 | Args: |
| 232 | previous_request: The request for the previous page. (required) |
| 233 | previous_response: The response from the request for the previous page. (required) |
| 234 | |
| 235 | Returns: |
| 236 | A request object that you can call 'execute()' on to request the next |
| 237 | page. Returns None if there are no more items in the collection. |
| 238 | </pre> |
| 239 | </div> |
| 240 | |
| 241 | </body></html> |