Package io.envoyproxy.envoy.type.http.v3

Class Cookie

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.type.http.v3.Cookie
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CookieOrBuilder, Serializable
public final class Cookie extends com.google.protobuf.GeneratedMessageV3 implements CookieOrBuilder
 Cookie defines an API for obtaining or generating HTTP cookie.
Protobuf type envoy.type.http.v3.Cookie
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Cookie.Builder
    Cookie defines an API for obtaining or generating HTTP cookie.

    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 final int
    ATTRIBUTES_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PATH_FIELD_NUMBER
     
    static final int
    TTL_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

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    CookieAttribute
    getAttributes(int index)
    Additional attributes for the cookie.
    int
    getAttributesCount()
    Additional attributes for the cookie.
    List<CookieAttribute>
    getAttributesList()
    Additional attributes for the cookie.
    CookieAttributeOrBuilder
    getAttributesOrBuilder(int index)
    Additional attributes for the cookie.
    List<? extends CookieAttributeOrBuilder>
    getAttributesOrBuilderList()
    Additional attributes for the cookie.
    static Cookie
    getDefaultInstance()
     
    Cookie
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    The name that will be used to obtain cookie value from downstream HTTP request or generate new cookie for downstream.
    com.google.protobuf.ByteString
    getNameBytes()
    The name that will be used to obtain cookie value from downstream HTTP request or generate new cookie for downstream.
    com.google.protobuf.Parser<Cookie>
    getParserForType()
     
    String
    getPath()
    Path of cookie.
    com.google.protobuf.ByteString
    getPathBytes()
    Path of cookie.
    int
    getSerializedSize()
     
    com.google.protobuf.Duration
    getTtl()
    Duration of cookie.
    com.google.protobuf.DurationOrBuilder
    getTtlOrBuilder()
    Duration of cookie.
    int
    hashCode()
     
    boolean
    hasTtl()
    Duration of cookie.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Cookie.Builder
    newBuilder()
     
    static Cookie.Builder
    newBuilder(Cookie prototype)
     
    Cookie.Builder
    newBuilderForType()
     
    protected Cookie.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Cookie
    parseDelimitedFrom(InputStream input)
     
    static Cookie
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cookie
    parseFrom(byte[] data)
     
    static Cookie
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cookie
    parseFrom(com.google.protobuf.ByteString data)
     
    static Cookie
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cookie
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Cookie
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cookie
    parseFrom(InputStream input)
     
    static Cookie
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cookie
    parseFrom(ByteBuffer data)
     
    static Cookie
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Cookie>
    parser()
     
    Cookie.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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 class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    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

  • Field Details

  • Method Details

    • 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 name that will be used to obtain cookie value from downstream HTTP request or generate
 new cookie for downstream.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getName in interface CookieOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name that will be used to obtain cookie value from downstream HTTP request or generate
 new cookie for downstream.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getNameBytes in interface CookieOrBuilder
      Returns:
      The bytes for name.

    • hasTtl

      public boolean hasTtl()
       Duration of cookie. This will be used to set the expiry time of a new cookie when it is
 generated. Set this to 0s to use a session cookie and disable cookie expiration.
      .google.protobuf.Duration ttl = 2 [(.validate.rules) = { ... }
      Specified by:
      hasTtl in interface CookieOrBuilder
      Returns:
      Whether the ttl field is set.

    • getTtl

      public com.google.protobuf.Duration getTtl()
       Duration of cookie. This will be used to set the expiry time of a new cookie when it is
 generated. Set this to 0s to use a session cookie and disable cookie expiration.
      .google.protobuf.Duration ttl = 2 [(.validate.rules) = { ... }
      Specified by:
      getTtl in interface CookieOrBuilder
      Returns:
      The ttl.

    • getTtlOrBuilder

      public com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
       Duration of cookie. This will be used to set the expiry time of a new cookie when it is
 generated. Set this to 0s to use a session cookie and disable cookie expiration.
      .google.protobuf.Duration ttl = 2 [(.validate.rules) = { ... }
      Specified by:
      getTtlOrBuilder in interface CookieOrBuilder

    • getPath

      public String getPath()
       Path of cookie. This will be used to set the path of a new cookie when it is generated.
 If no path is specified here, no path will be set for the cookie.
      string path = 3;
      Specified by:
      getPath in interface CookieOrBuilder
      Returns:
      The path.

    • getPathBytes

      public com.google.protobuf.ByteString getPathBytes()
       Path of cookie. This will be used to set the path of a new cookie when it is generated.
 If no path is specified here, no path will be set for the cookie.
      string path = 3;
      Specified by:
      getPathBytes in interface CookieOrBuilder
      Returns:
      The bytes for path.

    • getAttributesList

      public List<CookieAttribute> getAttributesList()
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.type.http.v3.CookieAttribute attributes = 4;
      Specified by:
      getAttributesList in interface CookieOrBuilder

    • getAttributesOrBuilderList

      public List<? extends CookieAttributeOrBuilder> getAttributesOrBuilderList()
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.type.http.v3.CookieAttribute attributes = 4;
      Specified by:
      getAttributesOrBuilderList in interface CookieOrBuilder

    • getAttributesCount

      public int getAttributesCount()
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.type.http.v3.CookieAttribute attributes = 4;
      Specified by:
      getAttributesCount in interface CookieOrBuilder

    • getAttributes

      public CookieAttribute getAttributes(int index)
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.type.http.v3.CookieAttribute attributes = 4;
      Specified by:
      getAttributes in interface CookieOrBuilder

    • getAttributesOrBuilder

      public CookieAttributeOrBuilder getAttributesOrBuilder(int index)
       Additional attributes for the cookie. They will be used when generating a new cookie.
      repeated .envoy.type.http.v3.CookieAttribute attributes = 4;
      Specified by:
      getAttributesOrBuilder in interface CookieOrBuilder

    • 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 Cookie parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Cookie parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Cookie parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Cookie parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Cookie parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Cookie parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Cookie parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Cookie parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Cookie.Builder newBuilder()

    • newBuilder

      public static Cookie.Builder newBuilder(Cookie prototype)

    • toBuilder

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

    • newBuilderForType

      protected Cookie.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Cookie getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Cookie> parser()

    • getParserForType

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