Interface CacheInvalidationRuleOrBuilder (1.113.0)

public interface CacheInvalidationRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBackendService()

public abstract String getBackendService()

If set, this invalidation rule will only apply to requests routed to the given backend service or backend bucket. For example, for a backend bucket bb1 in the same scope as the URL map, the path would be projects/my-project/global/backendBuckets/bb1; and for a backend service bs1 in the same scope as the URL map, the path would be projects/my-project/global/backendServices/bs1.

optional string backend_service = 306946058;

Returns
Type Description
String

The backendService.

getBackendServiceBytes()

public abstract ByteString getBackendServiceBytes()

If set, this invalidation rule will only apply to requests routed to the given backend service or backend bucket. For example, for a backend bucket bb1 in the same scope as the URL map, the path would be projects/my-project/global/backendBuckets/bb1; and for a backend service bs1 in the same scope as the URL map, the path would be projects/my-project/global/backendServices/bs1.

optional string backend_service = 306946058;

Returns
Type Description
ByteString

The bytes for backendService.

getCacheTags(int index)

public abstract String getCacheTags(int index)

A list of cache tags used to identify cached objects.

  • Cache tags are specified when the response is first cached, by setting the Cache-Tag response header at the origin.
  • Multiple cache tags in the same invalidation request are treated as Boolean OR - for example, tag1 OR tag2 OR tag3.
  • If other fields are also specified, these are treated as Boolean AND with any tags.

Up to 10 tags can be specified in a single invalidation request.

repeated string cache_tags = 29073078;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The cacheTags at the given index.

getCacheTagsBytes(int index)

public abstract ByteString getCacheTagsBytes(int index)

A list of cache tags used to identify cached objects.

  • Cache tags are specified when the response is first cached, by setting the Cache-Tag response header at the origin.
  • Multiple cache tags in the same invalidation request are treated as Boolean OR - for example, tag1 OR tag2 OR tag3.
  • If other fields are also specified, these are treated as Boolean AND with any tags.

Up to 10 tags can be specified in a single invalidation request.

repeated string cache_tags = 29073078;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the cacheTags at the given index.

getCacheTagsCount()

public abstract int getCacheTagsCount()

A list of cache tags used to identify cached objects.

  • Cache tags are specified when the response is first cached, by setting the Cache-Tag response header at the origin.
  • Multiple cache tags in the same invalidation request are treated as Boolean OR - for example, tag1 OR tag2 OR tag3.
  • If other fields are also specified, these are treated as Boolean AND with any tags.

Up to 10 tags can be specified in a single invalidation request.

repeated string cache_tags = 29073078;

Returns
Type Description
int

The count of cacheTags.

getCacheTagsList()

public abstract List<String> getCacheTagsList()

A list of cache tags used to identify cached objects.

  • Cache tags are specified when the response is first cached, by setting the Cache-Tag response header at the origin.
  • Multiple cache tags in the same invalidation request are treated as Boolean OR - for example, tag1 OR tag2 OR tag3.
  • If other fields are also specified, these are treated as Boolean AND with any tags.

Up to 10 tags can be specified in a single invalidation request.

repeated string cache_tags = 29073078;

Returns
Type Description
List<String>

A list containing the cacheTags.

getContentType()

public abstract String getContentType()

If set, this invalidation rule will only apply to responses with the given content-type. Parameters are not allowed and are ignored from the response when matching. Wildcards are not allowed.

optional string content_type = 294975296;

Returns
Type Description
String

The contentType.

getContentTypeBytes()

public abstract ByteString getContentTypeBytes()

If set, this invalidation rule will only apply to responses with the given content-type. Parameters are not allowed and are ignored from the response when matching. Wildcards are not allowed.

optional string content_type = 294975296;

Returns
Type Description
ByteString

The bytes for contentType.

getHost()

public abstract String getHost()

If set, this invalidation rule will only apply to requests with a Host header matching host. This field also accepts wildcards (*) to replace the leftmost (or first) label of a hostname. For example, *.example.com will match www.example.com, but not sub1.dev.example.com.

optional string host = 3208616;

Returns
Type Description
String

The host.

getHostBytes()

public abstract ByteString getHostBytes()

If set, this invalidation rule will only apply to requests with a Host header matching host. This field also accepts wildcards (*) to replace the leftmost (or first) label of a hostname. For example, *.example.com will match www.example.com, but not sub1.dev.example.com.

optional string host = 3208616;

Returns
Type Description
ByteString

The bytes for host.

getHttpStatus()

public abstract int getHttpStatus()

If set, this invalidation rule will only apply to responses with the given HTTP status. Valid range is 200-599.

optional int32 http_status = 468949897;

Returns
Type Description
int

The httpStatus.

getPath()

public abstract String getPath()

optional string path = 3433509;

Returns
Type Description
String

The path.

getPathBytes()

public abstract ByteString getPathBytes()

optional string path = 3433509;

Returns
Type Description
ByteString

The bytes for path.

hasBackendService()

public abstract boolean hasBackendService()

If set, this invalidation rule will only apply to requests routed to the given backend service or backend bucket. For example, for a backend bucket bb1 in the same scope as the URL map, the path would be projects/my-project/global/backendBuckets/bb1; and for a backend service bs1 in the same scope as the URL map, the path would be projects/my-project/global/backendServices/bs1.

optional string backend_service = 306946058;

Returns
Type Description
boolean

Whether the backendService field is set.

hasContentType()

public abstract boolean hasContentType()

If set, this invalidation rule will only apply to responses with the given content-type. Parameters are not allowed and are ignored from the response when matching. Wildcards are not allowed.

optional string content_type = 294975296;

Returns
Type Description
boolean

Whether the contentType field is set.

hasHost()

public abstract boolean hasHost()

If set, this invalidation rule will only apply to requests with a Host header matching host. This field also accepts wildcards (*) to replace the leftmost (or first) label of a hostname. For example, *.example.com will match www.example.com, but not sub1.dev.example.com.

optional string host = 3208616;

Returns
Type Description
boolean

Whether the host field is set.

hasHttpStatus()

public abstract boolean hasHttpStatus()

If set, this invalidation rule will only apply to responses with the given HTTP status. Valid range is 200-599.

optional int32 http_status = 468949897;

Returns
Type Description
boolean

Whether the httpStatus field is set.

hasPath()

public abstract boolean hasPath()

optional string path = 3433509;

Returns
Type Description
boolean

Whether the path field is set.