Package com.google.cloud.compute.v1

Class CachePolicyCacheKeyPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.CachePolicyCacheKeyPolicy
All Implemented Interfaces:
CachePolicyCacheKeyPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CachePolicyCacheKeyPolicy extends com.google.protobuf.GeneratedMessage implements CachePolicyCacheKeyPolicyOrBuilder
 Message containing what to include in the cache key for a request for Cache
 Policy defined on Route Action.
Protobuf type google.cloud.compute.v1.CachePolicyCacheKeyPolicy
See Also:

  • Field Details

    • EXCLUDED_QUERY_PARAMETERS_FIELD_NUMBER

      public static final int EXCLUDED_QUERY_PARAMETERS_FIELD_NUMBER
      See Also:

    • INCLUDE_HOST_FIELD_NUMBER

      public static final int INCLUDE_HOST_FIELD_NUMBER
      See Also:

    • INCLUDE_PROTOCOL_FIELD_NUMBER

      public static final int INCLUDE_PROTOCOL_FIELD_NUMBER
      See Also:

    • INCLUDE_QUERY_STRING_FIELD_NUMBER

      public static final int INCLUDE_QUERY_STRING_FIELD_NUMBER
      See Also:

    • INCLUDED_HEADER_NAMES_FIELD_NUMBER

      public static final int INCLUDED_HEADER_NAMES_FIELD_NUMBER
      See Also:

    • INCLUDED_QUERY_PARAMETERS_FIELD_NUMBER

      public static final int INCLUDED_QUERY_PARAMETERS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getExcludedQueryParametersList

      public com.google.protobuf.ProtocolStringList getExcludedQueryParametersList()
       Names of query string parameters to exclude in cache keys. All other
 parameters will be included. Either specify `excludedQueryParameters`
 or `includedQueryParameters`, not both. '&' and '=' will be percent
 encoded and not treated as delimiters.

 Note: This field applies to routes that use backend services. Attempting
 to set it on a route that points exclusively to Backend Buckets will
 result in a configuration error. For routes that point to a Backend
 Bucket, use `includedQueryParameters` to define which parameters should
 be part of the cache key.
      repeated string excluded_query_parameters = 124896150;
      Specified by:
      getExcludedQueryParametersList in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      A list containing the excludedQueryParameters.

    • getExcludedQueryParametersCount

      public int getExcludedQueryParametersCount()
       Names of query string parameters to exclude in cache keys. All other
 parameters will be included. Either specify `excludedQueryParameters`
 or `includedQueryParameters`, not both. '&' and '=' will be percent
 encoded and not treated as delimiters.

 Note: This field applies to routes that use backend services. Attempting
 to set it on a route that points exclusively to Backend Buckets will
 result in a configuration error. For routes that point to a Backend
 Bucket, use `includedQueryParameters` to define which parameters should
 be part of the cache key.
      repeated string excluded_query_parameters = 124896150;
      Specified by:
      getExcludedQueryParametersCount in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      The count of excludedQueryParameters.

    • getExcludedQueryParameters

      public String getExcludedQueryParameters(int index)
       Names of query string parameters to exclude in cache keys. All other
 parameters will be included. Either specify `excludedQueryParameters`
 or `includedQueryParameters`, not both. '&' and '=' will be percent
 encoded and not treated as delimiters.

 Note: This field applies to routes that use backend services. Attempting
 to set it on a route that points exclusively to Backend Buckets will
 result in a configuration error. For routes that point to a Backend
 Bucket, use `includedQueryParameters` to define which parameters should
 be part of the cache key.
      repeated string excluded_query_parameters = 124896150;
      Specified by:
      getExcludedQueryParameters in interface CachePolicyCacheKeyPolicyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The excludedQueryParameters at the given index.

    • getExcludedQueryParametersBytes

      public com.google.protobuf.ByteString getExcludedQueryParametersBytes(int index)
       Names of query string parameters to exclude in cache keys. All other
 parameters will be included. Either specify `excludedQueryParameters`
 or `includedQueryParameters`, not both. '&' and '=' will be percent
 encoded and not treated as delimiters.

 Note: This field applies to routes that use backend services. Attempting
 to set it on a route that points exclusively to Backend Buckets will
 result in a configuration error. For routes that point to a Backend
 Bucket, use `includedQueryParameters` to define which parameters should
 be part of the cache key.
      repeated string excluded_query_parameters = 124896150;
      Specified by:
      getExcludedQueryParametersBytes in interface CachePolicyCacheKeyPolicyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the excludedQueryParameters at the given index.

    • hasIncludeHost

      public boolean hasIncludeHost()
       If true, requests to different hosts will be cached separately.

 Note: This setting is only applicable to routes that use a Backend
 Service. It does not affect requests served by a Backend Bucket, as the
 host is never included in a Backend Bucket's cache key. Attempting to set
 it on a route that points exclusively to Backend Buckets will result in a
 configuration error.
      optional bool include_host = 486867679;
      Specified by:
      hasIncludeHost in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      Whether the includeHost field is set.

    • getIncludeHost

      public boolean getIncludeHost()
       If true, requests to different hosts will be cached separately.

 Note: This setting is only applicable to routes that use a Backend
 Service. It does not affect requests served by a Backend Bucket, as the
 host is never included in a Backend Bucket's cache key. Attempting to set
 it on a route that points exclusively to Backend Buckets will result in a
 configuration error.
      optional bool include_host = 486867679;
      Specified by:
      getIncludeHost in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      The includeHost.

    • hasIncludeProtocol

      public boolean hasIncludeProtocol()
       If true, http and https requests will be cached separately.

 Note: This setting is only applicable to routes that use a Backend
 Service. It does not affect requests served by a Backend Bucket, as the
 protocol is never included in a Backend Bucket's cache key. Attempting to
 set on a route that points exclusively to Backend Buckets will result in
 a configuration error.
      optional bool include_protocol = 303507535;
      Specified by:
      hasIncludeProtocol in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      Whether the includeProtocol field is set.

    • getIncludeProtocol

      public boolean getIncludeProtocol()
       If true, http and https requests will be cached separately.

 Note: This setting is only applicable to routes that use a Backend
 Service. It does not affect requests served by a Backend Bucket, as the
 protocol is never included in a Backend Bucket's cache key. Attempting to
 set on a route that points exclusively to Backend Buckets will result in
 a configuration error.
      optional bool include_protocol = 303507535;
      Specified by:
      getIncludeProtocol in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      The includeProtocol.

    • hasIncludeQueryString

      public boolean hasIncludeQueryString()
       If true, include query string parameters in the cache key according to
 `includedQueryParameters` and `excludedQueryParameters`. If neither
 is set, the entire query string will be included. If false, the query
 string will be excluded from the cache key entirely.

 Note: This field applies to routes that use backend services. Attempting
 to set it on a route that points exclusively to Backend Buckets will
 result in a configuration error. For routes that point to a Backend
 Bucket, use `includedQueryParameters` to define which parameters should
 be part of the cache key.
      optional bool include_query_string = 474036639;
      Specified by:
      hasIncludeQueryString in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      Whether the includeQueryString field is set.

    • getIncludeQueryString

      public boolean getIncludeQueryString()
       If true, include query string parameters in the cache key according to
 `includedQueryParameters` and `excludedQueryParameters`. If neither
 is set, the entire query string will be included. If false, the query
 string will be excluded from the cache key entirely.

 Note: This field applies to routes that use backend services. Attempting
 to set it on a route that points exclusively to Backend Buckets will
 result in a configuration error. For routes that point to a Backend
 Bucket, use `includedQueryParameters` to define which parameters should
 be part of the cache key.
      optional bool include_query_string = 474036639;
      Specified by:
      getIncludeQueryString in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      The includeQueryString.

    • getIncludedCookieNamesList

      public com.google.protobuf.ProtocolStringList getIncludedCookieNamesList()
       Allows HTTP cookies (by name) to be used in the cache key.
 The name=value pair will be used in the cache key Cloud CDN generates.

 Note: This setting is only applicable to routes that use a Backend
 Service. It does not affect requests served by a Backend Bucket.
 Attempting to set it on a route that points exclusively to Backend
 Buckets will result in a configuration error. Up to 5 cookie names can be
 specified.
      repeated string included_cookie_names = 66987088;
      Specified by:
      getIncludedCookieNamesList in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      A list containing the includedCookieNames.

    • getIncludedCookieNamesCount

      public int getIncludedCookieNamesCount()
       Allows HTTP cookies (by name) to be used in the cache key.
 The name=value pair will be used in the cache key Cloud CDN generates.

 Note: This setting is only applicable to routes that use a Backend
 Service. It does not affect requests served by a Backend Bucket.
 Attempting to set it on a route that points exclusively to Backend
 Buckets will result in a configuration error. Up to 5 cookie names can be
 specified.
      repeated string included_cookie_names = 66987088;
      Specified by:
      getIncludedCookieNamesCount in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      The count of includedCookieNames.

    • getIncludedCookieNames

      public String getIncludedCookieNames(int index)
       Allows HTTP cookies (by name) to be used in the cache key.
 The name=value pair will be used in the cache key Cloud CDN generates.

 Note: This setting is only applicable to routes that use a Backend
 Service. It does not affect requests served by a Backend Bucket.
 Attempting to set it on a route that points exclusively to Backend
 Buckets will result in a configuration error. Up to 5 cookie names can be
 specified.
      repeated string included_cookie_names = 66987088;
      Specified by:
      getIncludedCookieNames in interface CachePolicyCacheKeyPolicyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The includedCookieNames at the given index.

    • getIncludedCookieNamesBytes

      public com.google.protobuf.ByteString getIncludedCookieNamesBytes(int index)
       Allows HTTP cookies (by name) to be used in the cache key.
 The name=value pair will be used in the cache key Cloud CDN generates.

 Note: This setting is only applicable to routes that use a Backend
 Service. It does not affect requests served by a Backend Bucket.
 Attempting to set it on a route that points exclusively to Backend
 Buckets will result in a configuration error. Up to 5 cookie names can be
 specified.
      repeated string included_cookie_names = 66987088;
      Specified by:
      getIncludedCookieNamesBytes in interface CachePolicyCacheKeyPolicyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includedCookieNames at the given index.

    • getIncludedHeaderNamesList

      public com.google.protobuf.ProtocolStringList getIncludedHeaderNamesList()
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string included_header_names = 533756345;
      Specified by:
      getIncludedHeaderNamesList in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      A list containing the includedHeaderNames.

    • getIncludedHeaderNamesCount

      public int getIncludedHeaderNamesCount()
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string included_header_names = 533756345;
      Specified by:
      getIncludedHeaderNamesCount in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      The count of includedHeaderNames.

    • getIncludedHeaderNames

      public String getIncludedHeaderNames(int index)
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string included_header_names = 533756345;
      Specified by:
      getIncludedHeaderNames in interface CachePolicyCacheKeyPolicyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The includedHeaderNames at the given index.

    • getIncludedHeaderNamesBytes

      public com.google.protobuf.ByteString getIncludedHeaderNamesBytes(int index)
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string included_header_names = 533756345;
      Specified by:
      getIncludedHeaderNamesBytes in interface CachePolicyCacheKeyPolicyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includedHeaderNames at the given index.

    • getIncludedQueryParametersList

      public com.google.protobuf.ProtocolStringList getIncludedQueryParametersList()
       Names of query string parameters to include in cache keys. All other
 parameters will be excluded. Either specify `includedQueryParameters`
 or `excludedQueryParameters`, not both. '&' and '=' will be percent
 encoded and not treated as delimiters.
      repeated string included_query_parameters = 2319076;
      Specified by:
      getIncludedQueryParametersList in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      A list containing the includedQueryParameters.

    • getIncludedQueryParametersCount

      public int getIncludedQueryParametersCount()
       Names of query string parameters to include in cache keys. All other
 parameters will be excluded. Either specify `includedQueryParameters`
 or `excludedQueryParameters`, not both. '&' and '=' will be percent
 encoded and not treated as delimiters.
      repeated string included_query_parameters = 2319076;
      Specified by:
      getIncludedQueryParametersCount in interface CachePolicyCacheKeyPolicyOrBuilder
      Returns:
      The count of includedQueryParameters.

    • getIncludedQueryParameters

      public String getIncludedQueryParameters(int index)
       Names of query string parameters to include in cache keys. All other
 parameters will be excluded. Either specify `includedQueryParameters`
 or `excludedQueryParameters`, not both. '&' and '=' will be percent
 encoded and not treated as delimiters.
      repeated string included_query_parameters = 2319076;
      Specified by:
      getIncludedQueryParameters in interface CachePolicyCacheKeyPolicyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The includedQueryParameters at the given index.

    • getIncludedQueryParametersBytes

      public com.google.protobuf.ByteString getIncludedQueryParametersBytes(int index)
       Names of query string parameters to include in cache keys. All other
 parameters will be excluded. Either specify `includedQueryParameters`
 or `excludedQueryParameters`, not both. '&' and '=' will be percent
 encoded and not treated as delimiters.
      repeated string included_query_parameters = 2319076;
      Specified by:
      getIncludedQueryParametersBytes in interface CachePolicyCacheKeyPolicyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includedQueryParameters 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CachePolicyCacheKeyPolicy.Builder newBuilder()

    • newBuilder

      public static CachePolicyCacheKeyPolicy.Builder newBuilder(CachePolicyCacheKeyPolicy prototype)

    • toBuilder

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

    • newBuilderForType

      protected CachePolicyCacheKeyPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CachePolicyCacheKeyPolicy getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CachePolicyCacheKeyPolicy> 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.GeneratedMessage

    • getDefaultInstanceForType

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