Class FulfillmentInfo

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

    public final class FulfillmentInfo
    extends com.google.protobuf.GeneratedMessageV3
    implements FulfillmentInfoOrBuilder
     Fulfillment information, such as the store IDs for in-store pickup or region
     IDs for different shipping methods.
     
    Protobuf type google.cloud.retail.v2alpha.FulfillmentInfo
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FulfillmentInfo.Builder
      Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
      • 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 PLACE_IDS_FIELD_NUMBER  
      static int TYPE_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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static FulfillmentInfo getDefaultInstance()  
      FulfillmentInfo getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<FulfillmentInfo> getParserForType()  
      String getPlaceIds​(int index)
      The IDs for this [type][google.cloud.retail.v2alpha.FulfillmentInfo.type], such as the store IDs for [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2alpha.FulfillmentInfo.type] or the region IDs for [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
      com.google.protobuf.ByteString getPlaceIdsBytes​(int index)
      The IDs for this [type][google.cloud.retail.v2alpha.FulfillmentInfo.type], such as the store IDs for [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2alpha.FulfillmentInfo.type] or the region IDs for [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
      int getPlaceIdsCount()
      The IDs for this [type][google.cloud.retail.v2alpha.FulfillmentInfo.type], such as the store IDs for [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2alpha.FulfillmentInfo.type] or the region IDs for [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
      com.google.protobuf.ProtocolStringList getPlaceIdsList()
      The IDs for this [type][google.cloud.retail.v2alpha.FulfillmentInfo.type], such as the store IDs for [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2alpha.FulfillmentInfo.type] or the region IDs for [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
      int getSerializedSize()  
      String getType()
      The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.
      com.google.protobuf.ByteString getTypeBytes()
      The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static FulfillmentInfo.Builder newBuilder()  
      static FulfillmentInfo.Builder newBuilder​(FulfillmentInfo prototype)  
      FulfillmentInfo.Builder newBuilderForType()  
      protected FulfillmentInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static FulfillmentInfo parseDelimitedFrom​(InputStream input)  
      static FulfillmentInfo parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FulfillmentInfo parseFrom​(byte[] data)  
      static FulfillmentInfo parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FulfillmentInfo parseFrom​(com.google.protobuf.ByteString data)  
      static FulfillmentInfo parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FulfillmentInfo parseFrom​(com.google.protobuf.CodedInputStream input)  
      static FulfillmentInfo parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FulfillmentInfo parseFrom​(InputStream input)  
      static FulfillmentInfo parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FulfillmentInfo parseFrom​(ByteBuffer data)  
      static FulfillmentInfo parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<FulfillmentInfo> parser()  
      FulfillmentInfo.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • 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
      • getType

        public String getType()
         The fulfillment type, including commonly used types (such as pickup in
         store and same day delivery), and custom types. Customers have to map
         custom types to their display names before rendering UI.
        
         Supported values:
        
         * "pickup-in-store"
         * "ship-to-store"
         * "same-day-delivery"
         * "next-day-delivery"
         * "custom-type-1"
         * "custom-type-2"
         * "custom-type-3"
         * "custom-type-4"
         * "custom-type-5"
        
         If this field is set to an invalid value other than these, an
         INVALID_ARGUMENT error is returned.
         
        string type = 1;
        Specified by:
        getType in interface FulfillmentInfoOrBuilder
        Returns:
        The type.
      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         The fulfillment type, including commonly used types (such as pickup in
         store and same day delivery), and custom types. Customers have to map
         custom types to their display names before rendering UI.
        
         Supported values:
        
         * "pickup-in-store"
         * "ship-to-store"
         * "same-day-delivery"
         * "next-day-delivery"
         * "custom-type-1"
         * "custom-type-2"
         * "custom-type-3"
         * "custom-type-4"
         * "custom-type-5"
        
         If this field is set to an invalid value other than these, an
         INVALID_ARGUMENT error is returned.
         
        string type = 1;
        Specified by:
        getTypeBytes in interface FulfillmentInfoOrBuilder
        Returns:
        The bytes for type.
      • getPlaceIdsList

        public com.google.protobuf.ProtocolStringList getPlaceIdsList()
         The IDs for this [type][google.cloud.retail.v2alpha.FulfillmentInfo.type],
         such as the store IDs for
         [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2alpha.FulfillmentInfo.type]
         or the region IDs for
         [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
        
         A maximum of 3000 values are allowed. Each value must be a string with a
         length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
         as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
         returned.
         
        repeated string place_ids = 2;
        Specified by:
        getPlaceIdsList in interface FulfillmentInfoOrBuilder
        Returns:
        A list containing the placeIds.
      • getPlaceIdsCount

        public int getPlaceIdsCount()
         The IDs for this [type][google.cloud.retail.v2alpha.FulfillmentInfo.type],
         such as the store IDs for
         [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2alpha.FulfillmentInfo.type]
         or the region IDs for
         [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
        
         A maximum of 3000 values are allowed. Each value must be a string with a
         length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
         as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
         returned.
         
        repeated string place_ids = 2;
        Specified by:
        getPlaceIdsCount in interface FulfillmentInfoOrBuilder
        Returns:
        The count of placeIds.
      • getPlaceIds

        public String getPlaceIds​(int index)
         The IDs for this [type][google.cloud.retail.v2alpha.FulfillmentInfo.type],
         such as the store IDs for
         [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2alpha.FulfillmentInfo.type]
         or the region IDs for
         [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
        
         A maximum of 3000 values are allowed. Each value must be a string with a
         length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
         as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
         returned.
         
        repeated string place_ids = 2;
        Specified by:
        getPlaceIds in interface FulfillmentInfoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The placeIds at the given index.
      • getPlaceIdsBytes

        public com.google.protobuf.ByteString getPlaceIdsBytes​(int index)
         The IDs for this [type][google.cloud.retail.v2alpha.FulfillmentInfo.type],
         such as the store IDs for
         [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2alpha.FulfillmentInfo.type]
         or the region IDs for
         [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
        
         A maximum of 3000 values are allowed. Each value must be a string with a
         length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
         as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
         returned.
         
        repeated string place_ids = 2;
        Specified by:
        getPlaceIdsBytes in interface FulfillmentInfoOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the placeIds at the given index.
      • 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 FulfillmentInfo parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

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

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