Class SavedQuery

  • All Implemented Interfaces:
    SavedQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class SavedQuery
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ANNOTATION_FILTER_FIELD_NUMBER

        public static final int ANNOTATION_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PROBLEM_TYPE_FIELD_NUMBER

        public static final int PROBLEM_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ANNOTATION_SPEC_COUNT_FIELD_NUMBER

        public static final int ANNOTATION_SPEC_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SUPPORT_AUTOML_TRAINING_FIELD_NUMBER

        public static final int SUPPORT_AUTOML_TRAINING_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getName

        public String getName()
         Output only. Resource name of the SavedQuery.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface SavedQueryOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Resource name of the SavedQuery.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface SavedQueryOrBuilder
        Returns:
        The bytes for name.
      • 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];
        Specified by:
        getDisplayName in interface SavedQueryOrBuilder
        Returns:
        The displayName.
      • getDisplayNameBytes

        public com.google.protobuf.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];
        Specified by:
        getDisplayNameBytes in interface SavedQueryOrBuilder
        Returns:
        The bytes for displayName.
      • hasMetadata

        public boolean hasMetadata()
         Some additional information about the SavedQuery.
         
        .google.protobuf.Value metadata = 12;
        Specified by:
        hasMetadata in interface SavedQueryOrBuilder
        Returns:
        Whether the metadata field is set.
      • getMetadata

        public com.google.protobuf.Value getMetadata()
         Some additional information about the SavedQuery.
         
        .google.protobuf.Value metadata = 12;
        Specified by:
        getMetadata in interface SavedQueryOrBuilder
        Returns:
        The metadata.
      • getMetadataOrBuilder

        public com.google.protobuf.ValueOrBuilder getMetadataOrBuilder()
         Some additional information about the SavedQuery.
         
        .google.protobuf.Value metadata = 12;
        Specified by:
        getMetadataOrBuilder in interface SavedQueryOrBuilder
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this SavedQuery was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface SavedQueryOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this SavedQuery was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface SavedQueryOrBuilder
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this SavedQuery was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface SavedQueryOrBuilder
      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Timestamp when SavedQuery was last updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface SavedQueryOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when SavedQuery was last updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface SavedQueryOrBuilder
        Returns:
        The updateTime.
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when SavedQuery was last updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface SavedQueryOrBuilder
      • getAnnotationFilter

        public String getAnnotationFilter()
         Output only. Filters on the Annotations in the dataset.
         
        string annotation_filter = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAnnotationFilter in interface SavedQueryOrBuilder
        Returns:
        The annotationFilter.
      • getAnnotationFilterBytes

        public com.google.protobuf.ByteString getAnnotationFilterBytes()
         Output only. Filters on the Annotations in the dataset.
         
        string annotation_filter = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAnnotationFilterBytes in interface SavedQueryOrBuilder
        Returns:
        The bytes for annotationFilter.
      • 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];
        Specified by:
        getProblemType in interface SavedQueryOrBuilder
        Returns:
        The problemType.
      • getProblemTypeBytes

        public com.google.protobuf.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];
        Specified by:
        getProblemTypeBytes in interface SavedQueryOrBuilder
        Returns:
        The bytes for problemType.
      • 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];
        Specified by:
        getAnnotationSpecCount in interface SavedQueryOrBuilder
        Returns:
        The annotationSpecCount.
      • getEtag

        public String getEtag()
         Used to perform a consistent read-modify-write update. If not set, a blind
         "overwrite" update happens.
         
        string etag = 8;
        Specified by:
        getEtag in interface SavedQueryOrBuilder
        Returns:
        The etag.
      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Used to perform a consistent read-modify-write update. If not set, a blind
         "overwrite" update happens.
         
        string etag = 8;
        Specified by:
        getEtagBytes in interface SavedQueryOrBuilder
        Returns:
        The bytes for etag.
      • 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];
        Specified by:
        getSupportAutomlTraining in interface SavedQueryOrBuilder
        Returns:
        The supportAutomlTraining.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static SavedQuery parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SavedQuery parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SavedQuery parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SavedQuery parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SavedQuery parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SavedQuery parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SavedQuery parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException
      • newBuilderForType

        public SavedQuery.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public SavedQuery.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected SavedQuery.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static SavedQuery getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<SavedQuery> parser()
      • getParserForType

        public com.google.protobuf.Parser<SavedQuery> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public SavedQuery getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder