Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SavedQuery.
A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
Generated from protobuf message google.cloud.aiplatform.v1.SavedQuery
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name of the SavedQuery. |
↳ display_name |
string
Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
↳ metadata |
Google\Protobuf\Value
Some additional information about the SavedQuery. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this SavedQuery was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when SavedQuery was last updated. |
↳ annotation_filter |
string
Output only. Filters on the Annotations in the dataset. |
↳ problem_type |
string
Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING |
↳ annotation_spec_count |
int
Output only. Number of AnnotationSpecs in the context of the SavedQuery. |
↳ etag |
string
Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens. |
↳ support_automl_training |
bool
Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training. |
getName
Output only. Resource name of the SavedQuery.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of the SavedQuery.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. The user-defined name of the SavedQuery.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. The user-defined name of the SavedQuery.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetadata
Some additional information about the SavedQuery.
Generated from protobuf field .google.protobuf.Value metadata = 12;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Value|null | |
hasMetadata
clearMetadata
setMetadata
Some additional information about the SavedQuery.
Generated from protobuf field .google.protobuf.Value metadata = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when this SavedQuery was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this SavedQuery was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp when SavedQuery was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when SavedQuery was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotationFilter
Output only. Filters on the Annotations in the dataset.
Generated from protobuf field string annotation_filter = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setAnnotationFilter
Output only. Filters on the Annotations in the dataset.
Generated from protobuf field string annotation_filter = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProblemType
Required. Problem type of the SavedQuery.
Allowed values:
- IMAGE_CLASSIFICATION_SINGLE_LABEL
- IMAGE_CLASSIFICATION_MULTI_LABEL
- IMAGE_BOUNDING_POLY
- IMAGE_BOUNDING_BOX
- TEXT_CLASSIFICATION_SINGLE_LABEL
- TEXT_CLASSIFICATION_MULTI_LABEL
- TEXT_EXTRACTION
- TEXT_SENTIMENT
- VIDEO_CLASSIFICATION
- VIDEO_OBJECT_TRACKING
Generated from protobuf field string problem_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setProblemType
Required. Problem type of the SavedQuery.
Allowed values:
- IMAGE_CLASSIFICATION_SINGLE_LABEL
- IMAGE_CLASSIFICATION_MULTI_LABEL
- IMAGE_BOUNDING_POLY
- IMAGE_BOUNDING_BOX
- TEXT_CLASSIFICATION_SINGLE_LABEL
- TEXT_CLASSIFICATION_MULTI_LABEL
- TEXT_EXTRACTION
- TEXT_SENTIMENT
- VIDEO_CLASSIFICATION
- VIDEO_OBJECT_TRACKING
Generated from protobuf field string problem_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotationSpecCount
Output only. Number of AnnotationSpecs in the context of the SavedQuery.
Generated from protobuf field int32 annotation_spec_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setAnnotationSpecCount
Output only. Number of AnnotationSpecs in the context of the SavedQuery.
Generated from protobuf field int32 annotation_spec_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 8;
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSupportAutomlTraining
Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
Generated from protobuf field bool support_automl_training = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
bool | |
setSupportAutomlTraining
Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
Generated from protobuf field bool support_automl_training = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |