Class ProductSet

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

    public final class ProductSet
    extends com.google.protobuf.GeneratedMessageV3
    implements ProductSetOrBuilder
     A ProductSet contains Products. A ProductSet can contain a maximum of 1
     million reference images. If the limit is exceeded, periodic indexing will
     fail.
     
    Protobuf type google.cloud.vision.v1p4beta1.ProductSet
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ProductSet.Builder
      A ProductSet contains Products.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DISPLAY_NAME_FIELD_NUMBER  
      static int INDEX_ERROR_FIELD_NUMBER  
      static int INDEX_TIME_FIELD_NUMBER  
      static int NAME_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • 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()
         The resource name of the ProductSet.
        
         Format is:
         `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
        
         This field is ignored when creating a ProductSet.
         
        string name = 1;
        Specified by:
        getName in interface ProductSetOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the ProductSet.
        
         Format is:
         `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
        
         This field is ignored when creating a ProductSet.
         
        string name = 1;
        Specified by:
        getNameBytes in interface ProductSetOrBuilder
        Returns:
        The bytes for name.
      • getDisplayName

        public String getDisplayName()
         The user-provided name for this ProductSet. Must not be empty. Must be at
         most 4096 characters long.
         
        string display_name = 2;
        Specified by:
        getDisplayName in interface ProductSetOrBuilder
        Returns:
        The displayName.
      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The user-provided name for this ProductSet. Must not be empty. Must be at
         most 4096 characters long.
         
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface ProductSetOrBuilder
        Returns:
        The bytes for displayName.
      • hasIndexTime

        public boolean hasIndexTime()
         Output only. The time at which this ProductSet was last indexed. Query
         results will reflect all updates before this time. If this ProductSet has
         never been indexed, this timestamp is the default value
         "1970-01-01T00:00:00Z".
        
         This field is ignored when creating a ProductSet.
         
        .google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasIndexTime in interface ProductSetOrBuilder
        Returns:
        Whether the indexTime field is set.
      • getIndexTime

        public com.google.protobuf.Timestamp getIndexTime()
         Output only. The time at which this ProductSet was last indexed. Query
         results will reflect all updates before this time. If this ProductSet has
         never been indexed, this timestamp is the default value
         "1970-01-01T00:00:00Z".
        
         This field is ignored when creating a ProductSet.
         
        .google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIndexTime in interface ProductSetOrBuilder
        Returns:
        The indexTime.
      • getIndexTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getIndexTimeOrBuilder()
         Output only. The time at which this ProductSet was last indexed. Query
         results will reflect all updates before this time. If this ProductSet has
         never been indexed, this timestamp is the default value
         "1970-01-01T00:00:00Z".
        
         This field is ignored when creating a ProductSet.
         
        .google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIndexTimeOrBuilder in interface ProductSetOrBuilder
      • hasIndexError

        public boolean hasIndexError()
         Output only. If there was an error with indexing the product set, the field
         is populated.
        
         This field is ignored when creating a ProductSet.
         
        .google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasIndexError in interface ProductSetOrBuilder
        Returns:
        Whether the indexError field is set.
      • getIndexError

        public com.google.rpc.Status getIndexError()
         Output only. If there was an error with indexing the product set, the field
         is populated.
        
         This field is ignored when creating a ProductSet.
         
        .google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIndexError in interface ProductSetOrBuilder
        Returns:
        The indexError.
      • getIndexErrorOrBuilder

        public com.google.rpc.StatusOrBuilder getIndexErrorOrBuilder()
         Output only. If there was an error with indexing the product set, the field
         is populated.
        
         This field is ignored when creating a ProductSet.
         
        .google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIndexErrorOrBuilder in interface ProductSetOrBuilder
      • 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 ProductSet parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static ProductSet getDefaultInstance()
      • parser

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

        public com.google.protobuf.Parser<ProductSet> 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 ProductSet getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder