Class DataItem.Builder

  • All Implemented Interfaces:
    DataItemOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    DataItem

    public static final class DataItem.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
    implements DataItemOrBuilder
     A piece of data in a Dataset. Could be an image, a video, a document or plain
     text.
     
    Protobuf type google.cloud.aiplatform.v1beta1.DataItem
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • clear

        public DataItem.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • getDefaultInstanceForType

        public DataItem getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public DataItem build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public DataItem buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public DataItem.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • setField

        public DataItem.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • clearField

        public DataItem.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • clearOneof

        public DataItem.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • setRepeatedField

        public DataItem.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • addRepeatedField

        public DataItem.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • mergeFrom

        public DataItem.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataItem.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • mergeFrom

        public DataItem.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataItem.Builder>
        Throws:
        IOException
      • getName

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

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the DataItem.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface DataItemOrBuilder
        Returns:
        The bytes for name.
      • setName

        public DataItem.Builder setName​(String value)
         Output only. The resource name of the DataItem.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public DataItem.Builder clearName()
         Output only. The resource name of the DataItem.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setNameBytes

        public DataItem.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the DataItem.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • hasCreateTime

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

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

        public DataItem.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when this DataItem was created.
         
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setCreateTime

        public DataItem.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Timestamp when this DataItem was created.
         
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeCreateTime

        public DataItem.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when this DataItem was created.
         
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearCreateTime

        public DataItem.Builder clearCreateTime()
         Output only. Timestamp when this DataItem was created.
         
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. Timestamp when this DataItem was created.
         
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeOrBuilder

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

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

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when this DataItem was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface DataItemOrBuilder
        Returns:
        The updateTime.
      • setUpdateTime

        public DataItem.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when this DataItem was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setUpdateTime

        public DataItem.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Timestamp when this DataItem was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeUpdateTime

        public DataItem.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when this DataItem was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearUpdateTime

        public DataItem.Builder clearUpdateTime()
         Output only. Timestamp when this DataItem was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         Output only. Timestamp when this DataItem was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when this DataItem was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface DataItemOrBuilder
      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: DataItemOrBuilder
         Optional. The labels with user-defined metadata to organize your DataItems.
        
         Label keys and values can be no longer than 64 characters
         (Unicode codepoints), can only contain lowercase letters, numeric
         characters, underscores and dashes. International characters are allowed.
         No more than 64 user labels can be associated with one DataItem(System
         labels are excluded).
        
         See https://goo.gl/xmQnxf for more information and examples of labels.
         System reserved label keys are prefixed with "aiplatform.googleapis.com/"
         and are immutable.
         
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface DataItemOrBuilder
      • containsLabels

        public boolean containsLabels​(String key)
         Optional. The labels with user-defined metadata to organize your DataItems.
        
         Label keys and values can be no longer than 64 characters
         (Unicode codepoints), can only contain lowercase letters, numeric
         characters, underscores and dashes. International characters are allowed.
         No more than 64 user labels can be associated with one DataItem(System
         labels are excluded).
        
         See https://goo.gl/xmQnxf for more information and examples of labels.
         System reserved label keys are prefixed with "aiplatform.googleapis.com/"
         and are immutable.
         
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface DataItemOrBuilder
      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. The labels with user-defined metadata to organize your DataItems.
        
         Label keys and values can be no longer than 64 characters
         (Unicode codepoints), can only contain lowercase letters, numeric
         characters, underscores and dashes. International characters are allowed.
         No more than 64 user labels can be associated with one DataItem(System
         labels are excluded).
        
         See https://goo.gl/xmQnxf for more information and examples of labels.
         System reserved label keys are prefixed with "aiplatform.googleapis.com/"
         and are immutable.
         
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface DataItemOrBuilder
      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                         String defaultValue)
         Optional. The labels with user-defined metadata to organize your DataItems.
        
         Label keys and values can be no longer than 64 characters
         (Unicode codepoints), can only contain lowercase letters, numeric
         characters, underscores and dashes. International characters are allowed.
         No more than 64 user labels can be associated with one DataItem(System
         labels are excluded).
        
         See https://goo.gl/xmQnxf for more information and examples of labels.
         System reserved label keys are prefixed with "aiplatform.googleapis.com/"
         and are immutable.
         
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface DataItemOrBuilder
      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. The labels with user-defined metadata to organize your DataItems.
        
         Label keys and values can be no longer than 64 characters
         (Unicode codepoints), can only contain lowercase letters, numeric
         characters, underscores and dashes. International characters are allowed.
         No more than 64 user labels can be associated with one DataItem(System
         labels are excluded).
        
         See https://goo.gl/xmQnxf for more information and examples of labels.
         System reserved label keys are prefixed with "aiplatform.googleapis.com/"
         and are immutable.
         
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface DataItemOrBuilder
      • removeLabels

        public DataItem.Builder removeLabels​(String key)
         Optional. The labels with user-defined metadata to organize your DataItems.
        
         Label keys and values can be no longer than 64 characters
         (Unicode codepoints), can only contain lowercase letters, numeric
         characters, underscores and dashes. International characters are allowed.
         No more than 64 user labels can be associated with one DataItem(System
         labels are excluded).
        
         See https://goo.gl/xmQnxf for more information and examples of labels.
         System reserved label keys are prefixed with "aiplatform.googleapis.com/"
         and are immutable.
         
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
      • getMutableLabels

        @Deprecated
        public Map<String,​String> getMutableLabels()
        Deprecated.
        Use alternate mutation accessors instead.
      • putLabels

        public DataItem.Builder putLabels​(String key,
                                          String value)
         Optional. The labels with user-defined metadata to organize your DataItems.
        
         Label keys and values can be no longer than 64 characters
         (Unicode codepoints), can only contain lowercase letters, numeric
         characters, underscores and dashes. International characters are allowed.
         No more than 64 user labels can be associated with one DataItem(System
         labels are excluded).
        
         See https://goo.gl/xmQnxf for more information and examples of labels.
         System reserved label keys are prefixed with "aiplatform.googleapis.com/"
         and are immutable.
         
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
      • putAllLabels

        public DataItem.Builder putAllLabels​(Map<String,​String> values)
         Optional. The labels with user-defined metadata to organize your DataItems.
        
         Label keys and values can be no longer than 64 characters
         (Unicode codepoints), can only contain lowercase letters, numeric
         characters, underscores and dashes. International characters are allowed.
         No more than 64 user labels can be associated with one DataItem(System
         labels are excluded).
        
         See https://goo.gl/xmQnxf for more information and examples of labels.
         System reserved label keys are prefixed with "aiplatform.googleapis.com/"
         and are immutable.
         
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
      • hasPayload

        public boolean hasPayload()
         Required. The data that the DataItem represents (for example, an image or a
         text snippet). The schema of the payload is stored in the parent Dataset's
         [metadata
         schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
         dataItemSchemaUri field.
         
        .google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasPayload in interface DataItemOrBuilder
        Returns:
        Whether the payload field is set.
      • getPayload

        public com.google.protobuf.Value getPayload()
         Required. The data that the DataItem represents (for example, an image or a
         text snippet). The schema of the payload is stored in the parent Dataset's
         [metadata
         schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
         dataItemSchemaUri field.
         
        .google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPayload in interface DataItemOrBuilder
        Returns:
        The payload.
      • setPayload

        public DataItem.Builder setPayload​(com.google.protobuf.Value value)
         Required. The data that the DataItem represents (for example, an image or a
         text snippet). The schema of the payload is stored in the parent Dataset's
         [metadata
         schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
         dataItemSchemaUri field.
         
        .google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
      • setPayload

        public DataItem.Builder setPayload​(com.google.protobuf.Value.Builder builderForValue)
         Required. The data that the DataItem represents (for example, an image or a
         text snippet). The schema of the payload is stored in the parent Dataset's
         [metadata
         schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
         dataItemSchemaUri field.
         
        .google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
      • mergePayload

        public DataItem.Builder mergePayload​(com.google.protobuf.Value value)
         Required. The data that the DataItem represents (for example, an image or a
         text snippet). The schema of the payload is stored in the parent Dataset's
         [metadata
         schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
         dataItemSchemaUri field.
         
        .google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
      • clearPayload

        public DataItem.Builder clearPayload()
         Required. The data that the DataItem represents (for example, an image or a
         text snippet). The schema of the payload is stored in the parent Dataset's
         [metadata
         schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
         dataItemSchemaUri field.
         
        .google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
      • getPayloadBuilder

        public com.google.protobuf.Value.Builder getPayloadBuilder()
         Required. The data that the DataItem represents (for example, an image or a
         text snippet). The schema of the payload is stored in the parent Dataset's
         [metadata
         schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
         dataItemSchemaUri field.
         
        .google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
      • getPayloadOrBuilder

        public com.google.protobuf.ValueOrBuilder getPayloadOrBuilder()
         Required. The data that the DataItem represents (for example, an image or a
         text snippet). The schema of the payload is stored in the parent Dataset's
         [metadata
         schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
         dataItemSchemaUri field.
         
        .google.protobuf.Value payload = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPayloadOrBuilder in interface DataItemOrBuilder
      • getEtag

        public String getEtag()
         Optional. Used to perform consistent read-modify-write updates. If not set,
         a blind "overwrite" update happens.
         
        string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtag in interface DataItemOrBuilder
        Returns:
        The etag.
      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Optional. Used to perform consistent read-modify-write updates. If not set,
         a blind "overwrite" update happens.
         
        string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtagBytes in interface DataItemOrBuilder
        Returns:
        The bytes for etag.
      • setEtag

        public DataItem.Builder setEtag​(String value)
         Optional. Used to perform consistent read-modify-write updates. If not set,
         a blind "overwrite" update happens.
         
        string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The etag to set.
        Returns:
        This builder for chaining.
      • clearEtag

        public DataItem.Builder clearEtag()
         Optional. Used to perform consistent read-modify-write updates. If not set,
         a blind "overwrite" update happens.
         
        string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setEtagBytes

        public DataItem.Builder setEtagBytes​(com.google.protobuf.ByteString value)
         Optional. Used to perform consistent read-modify-write updates. If not set,
         a blind "overwrite" update happens.
         
        string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for etag to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final DataItem.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>
      • mergeUnknownFields

        public final DataItem.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DataItem.Builder>