Google Cloud Ai Platform V1 Client - Class SavedQuery (1.3.0)

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

Namespace

Google \ Cloud \ AIPlatform \ V1

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.

Returns
Type Description
string

setName

Output only. Resource name of the SavedQuery.

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.

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getMetadata

Some additional information about the SavedQuery.

Returns
Type Description
Google\Protobuf\Value|null

hasMetadata

clearMetadata

setMetadata

Some additional information about the SavedQuery.

Parameter
Name Description
var Google\Protobuf\Value
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this SavedQuery was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this SavedQuery was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp when SavedQuery was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when SavedQuery was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getAnnotationFilter

Output only. Filters on the Annotations in the dataset.

Returns
Type Description
string

setAnnotationFilter

Output only. Filters on the Annotations in the dataset.

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
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
Parameter
Name Description
var string
Returns
Type Description
$this

getAnnotationSpecCount

Output only. Number of AnnotationSpecs in the context of the SavedQuery.

Returns
Type Description
int

setAnnotationSpecCount

Output only. Number of AnnotationSpecs in the context of the SavedQuery.

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.

Returns
Type Description
string

setEtag

Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens.

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.

Returns
Type Description
bool

setSupportAutomlTraining

Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.

Parameter
Name Description
var bool
Returns
Type Description
$this