You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/healthcare_v1beta1.projects.locations.datasets.annotationStores.annotations.html
+18-18Lines changed: 18 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -106,12 +106,12 @@ <h3>Method Details</h3>
106
106
<pre>Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.
107
107
108
108
Args:
109
-
parent: string, The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. (required)
109
+
parent: string, Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. (required)
110
110
body: object, The request body.
111
111
The object takes the form of:
112
112
113
113
{ # An annotation record.
114
-
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
114
+
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
115
115
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
116
116
"name": "A String", # Full path of a Cloud Healthcare API resource.
117
117
},
@@ -133,7 +133,7 @@ <h3>Method Details</h3>
133
133
],
134
134
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
135
135
},
136
-
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
136
+
"name": "A String", # Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
137
137
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
138
138
"label": "A String", # A description of the annotation record.
139
139
},
@@ -162,7 +162,7 @@ <h3>Method Details</h3>
162
162
An object of the form:
163
163
164
164
{ # An annotation record.
165
-
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
165
+
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
166
166
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
167
167
"name": "A String", # Full path of a Cloud Healthcare API resource.
168
168
},
@@ -184,7 +184,7 @@ <h3>Method Details</h3>
184
184
],
185
185
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
186
186
},
187
-
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
187
+
"name": "A String", # Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
188
188
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
189
189
"label": "A String", # A description of the annotation record.
190
190
},
@@ -210,7 +210,7 @@ <h3>Method Details</h3>
210
210
<pre>Deletes an Annotation or returns NOT_FOUND if it does not exist.
211
211
212
212
Args:
213
-
name: string, The resource name of the Annotation to delete. (required)
213
+
name: string, Required. The resource name of the Annotation to delete. (required)
214
214
x__xgafv: string, V1 error format.
215
215
Allowed values
216
216
1 - v1 error format
@@ -228,7 +228,7 @@ <h3>Method Details</h3>
228
228
<pre>Gets an Annotation.
229
229
230
230
Args:
231
-
name: string, The resource name of the Annotation to retrieve. (required)
231
+
name: string, Required. The resource name of the Annotation to retrieve. (required)
232
232
x__xgafv: string, V1 error format.
233
233
Allowed values
234
234
1 - v1 error format
@@ -238,7 +238,7 @@ <h3>Method Details</h3>
238
238
An object of the form:
239
239
240
240
{ # An annotation record.
241
-
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
241
+
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
242
242
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
243
243
"name": "A String", # Full path of a Cloud Healthcare API resource.
244
244
},
@@ -260,7 +260,7 @@ <h3>Method Details</h3>
260
260
],
261
261
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
262
262
},
263
-
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
263
+
"name": "A String", # Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
264
264
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
265
265
"label": "A String", # A description of the annotation record.
266
266
},
@@ -286,7 +286,7 @@ <h3>Method Details</h3>
286
286
<pre>Lists the Annotations in the given Annotation store for a source resource.
287
287
288
288
Args:
289
-
parent: string, Name of the Annotation store to retrieve Annotations from. (required)
289
+
parent: string, Required. Name of the Annotation store to retrieve Annotations from. (required)
290
290
filter: string, Restricts Annotations returned to those matching a filter. Functions available for filtering are: - `matches("annotation_source.cloud_healthcare_source.name", substring)`. Filter on `cloud_healthcare_source.name`. For example: `matches("annotation_source.cloud_healthcare_source.name", "some source")`. - `matches("annotation", substring)`. Filter on all fields of annotation. For example: `matches("annotation", "some-content")`. - `type("text")`, `type("image")`, `type("resource")`. Filter on the type of annotation `data`.
291
291
pageSize: integer, Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000.
292
292
pageToken: string, The next_page_token value returned from the previous List request, if any.
@@ -306,7 +306,7 @@ <h3>Method Details</h3>
306
306
{ # Lists the Annotations in the specified Annotation store.
307
307
"annotations": [ # The returned Annotations. Won't be more values than the value of page_size in the request. See `AnnotationView` in the request for populated fields.
308
308
{ # An annotation record.
309
-
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
309
+
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
310
310
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
311
311
"name": "A String", # Full path of a Cloud Healthcare API resource.
312
312
},
@@ -328,7 +328,7 @@ <h3>Method Details</h3>
328
328
],
329
329
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
330
330
},
331
-
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
331
+
"name": "A String", # Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
332
332
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
333
333
"label": "A String", # A description of the annotation record.
334
334
},
@@ -371,12 +371,12 @@ <h3>Method Details</h3>
371
371
<pre>Updates the Annotation.
372
372
373
373
Args:
374
-
name: string, Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. (required)
374
+
name: string, Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. (required)
375
375
body: object, The request body.
376
376
The object takes the form of:
377
377
378
378
{ # An annotation record.
379
-
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
379
+
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
380
380
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
381
381
"name": "A String", # Full path of a Cloud Healthcare API resource.
382
382
},
@@ -398,7 +398,7 @@ <h3>Method Details</h3>
398
398
],
399
399
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
400
400
},
401
-
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
401
+
"name": "A String", # Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
402
402
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
403
403
"label": "A String", # A description of the annotation record.
404
404
},
@@ -418,7 +418,7 @@ <h3>Method Details</h3>
418
418
},
419
419
}
420
420
421
-
updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
421
+
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
422
422
x__xgafv: string, V1 error format.
423
423
Allowed values
424
424
1 - v1 error format
@@ -428,7 +428,7 @@ <h3>Method Details</h3>
428
428
An object of the form:
429
429
430
430
{ # An annotation record.
431
-
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
431
+
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
432
432
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
433
433
"name": "A String", # Full path of a Cloud Healthcare API resource.
434
434
},
@@ -450,7 +450,7 @@ <h3>Method Details</h3>
450
450
],
451
451
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
452
452
},
453
-
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
453
+
"name": "A String", # Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
454
454
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
455
455
"label": "A String", # A description of the annotation record.
0 commit comments