Class SavedQuery (3.56.0)

public final class SavedQuery extends GeneratedMessageV3 implements SavedQueryOrBuilder

A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.

Protobuf type google.cloud.aiplatform.v1.SavedQuery

Implements

SavedQueryOrBuilder

Static Fields

ANNOTATION_FILTER_FIELD_NUMBER

public static final int ANNOTATION_FILTER_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATION_SPEC_COUNT_FIELD_NUMBER

public static final int ANNOTATION_SPEC_COUNT_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROBLEM_TYPE_FIELD_NUMBER

public static final int PROBLEM_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SUPPORT_AUTOML_TRAINING_FIELD_NUMBER

public static final int SUPPORT_AUTOML_TRAINING_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SavedQuery getDefaultInstance()
Returns
Type Description
SavedQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SavedQuery.Builder newBuilder()
Returns
Type Description
SavedQuery.Builder

newBuilder(SavedQuery prototype)

public static SavedQuery.Builder newBuilder(SavedQuery prototype)
Parameter
Name Description
prototype SavedQuery
Returns
Type Description
SavedQuery.Builder

parseDelimitedFrom(InputStream input)

public static SavedQuery parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SavedQuery
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SavedQuery
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SavedQuery parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SavedQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SavedQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SavedQuery parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SavedQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SavedQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SavedQuery parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SavedQuery
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SavedQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SavedQuery parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SavedQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SavedQuery
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SavedQuery parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SavedQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SavedQuery
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SavedQuery> parser()
Returns
Type Description
Parser<SavedQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotationFilter()

public String getAnnotationFilter()

Output only. Filters on the Annotations in the dataset.

string annotation_filter = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The annotationFilter.

getAnnotationFilterBytes()

public ByteString getAnnotationFilterBytes()

Output only. Filters on the Annotations in the dataset.

string annotation_filter = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for annotationFilter.

getAnnotationSpecCount()

public int getAnnotationSpecCount()

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

int32 annotation_spec_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The annotationSpecCount.

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this SavedQuery was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this SavedQuery was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public SavedQuery getDefaultInstanceForType()
Returns
Type Description
SavedQuery

getDisplayName()

public String 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.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

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

string etag = 8;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 8;

Returns
Type Description
ByteString

The bytes for etag.

getMetadata()

public Value getMetadata()

Some additional information about the SavedQuery.

.google.protobuf.Value metadata = 12;

Returns
Type Description
Value

The metadata.

getMetadataOrBuilder()

public ValueOrBuilder getMetadataOrBuilder()

Some additional information about the SavedQuery.

.google.protobuf.Value metadata = 12;

Returns
Type Description
ValueOrBuilder

getName()

public String getName()

Output only. Resource name of the SavedQuery.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the SavedQuery.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<SavedQuery> getParserForType()
Returns
Type Description
Parser<SavedQuery>
Overrides

getProblemType()

public String 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

string problem_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The problemType.

getProblemTypeBytes()

public ByteString getProblemTypeBytes()

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

string problem_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for problemType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSupportAutomlTraining()

public boolean getSupportAutomlTraining()

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

bool support_automl_training = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The supportAutomlTraining.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when SavedQuery was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when SavedQuery was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this SavedQuery was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetadata()

public boolean hasMetadata()

Some additional information about the SavedQuery.

.google.protobuf.Value metadata = 12;

Returns
Type Description
boolean

Whether the metadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when SavedQuery was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SavedQuery.Builder newBuilderForType()
Returns
Type Description
SavedQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SavedQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SavedQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SavedQuery.Builder toBuilder()
Returns
Type Description
SavedQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException