Class SavedQuery (3.38.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
TypeDescription
int

ANNOTATION_SPEC_COUNT_FIELD_NUMBER

public static final int ANNOTATION_SPEC_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROBLEM_TYPE_FIELD_NUMBER

public static final int PROBLEM_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

SUPPORT_AUTOML_TRAINING_FIELD_NUMBER

public static final int SUPPORT_AUTOML_TRAINING_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SavedQuery getDefaultInstance()
Returns
TypeDescription
SavedQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SavedQuery.Builder newBuilder()
Returns
TypeDescription
SavedQuery.Builder

newBuilder(SavedQuery prototype)

public static SavedQuery.Builder newBuilder(SavedQuery prototype)
Parameter
NameDescription
prototypeSavedQuery
Returns
TypeDescription
SavedQuery.Builder

parseDelimitedFrom(InputStream input)

public static SavedQuery parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SavedQuery parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SavedQuery parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SavedQuery parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SavedQuery parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SavedQuery parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SavedQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SavedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SavedQuery> parser()
Returns
TypeDescription
Parser<SavedQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public SavedQuery getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for etag.

getMetadata()

public Value getMetadata()

Some additional information about the SavedQuery.

.google.protobuf.Value metadata = 12;

Returns
TypeDescription
Value

The metadata.

getMetadataOrBuilder()

public ValueOrBuilder getMetadataOrBuilder()

Some additional information about the SavedQuery.

.google.protobuf.Value metadata = 12;

Returns
TypeDescription
ValueOrBuilder

getName()

public String getName()

Output only. Resource name of the SavedQuery.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the SavedQuery.

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<SavedQuery> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for problemType.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the createTime field is set.

hasMetadata()

public boolean hasMetadata()

Some additional information about the SavedQuery.

.google.protobuf.Value metadata = 12;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SavedQuery.Builder newBuilderForType()
Returns
TypeDescription
SavedQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SavedQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SavedQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SavedQuery.Builder toBuilder()
Returns
TypeDescription
SavedQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException