Class AnywhereCache.Builder (2.53.0)

public static final class AnywhereCache.Builder extends GeneratedMessageV3.Builder<AnywhereCache.Builder> implements AnywhereCacheOrBuilder

An Anywhere Cache Instance.

Protobuf type google.storage.control.v2.AnywhereCache

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnywhereCache.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnywhereCache.Builder
Overrides

build()

public AnywhereCache build()
Returns
Type Description
AnywhereCache

buildPartial()

public AnywhereCache buildPartial()
Returns
Type Description
AnywhereCache

clear()

public AnywhereCache.Builder clear()
Returns
Type Description
AnywhereCache.Builder
Overrides

clearAdmissionPolicy()

public AnywhereCache.Builder clearAdmissionPolicy()

Cache admission policy. Valid policies includes: admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss. Default value is applied if not specified in the create request.

string admission_policy = 9;

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

clearCreateTime()

public AnywhereCache.Builder clearCreateTime()

Output only. Time when Anywhere cache instance is allocated.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AnywhereCache.Builder

clearField(Descriptors.FieldDescriptor field)

public AnywhereCache.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AnywhereCache.Builder
Overrides

clearName()

public AnywhereCache.Builder clearName()

Immutable. The resource name of this AnywhereCache. Format: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AnywhereCache.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AnywhereCache.Builder
Overrides

clearPendingUpdate()

public AnywhereCache.Builder clearPendingUpdate()

Output only. True if there is an active update operation against this cache instance. Subsequential update requests will be rejected if this field is true. Output only.

bool pending_update = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

clearState()

public AnywhereCache.Builder clearState()

Output only. Cache state including RUNNING, CREATING, DISABLED and PAUSED.

string state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

clearTtl()

public AnywhereCache.Builder clearTtl()

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

.google.protobuf.Duration ttl = 3;

Returns
Type Description
AnywhereCache.Builder

clearUpdateTime()

public AnywhereCache.Builder clearUpdateTime()

Output only. Time when Anywhere cache instance is last updated, including creation.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AnywhereCache.Builder

clearZone()

public AnywhereCache.Builder clearZone()

Immutable. The zone in which the cache instance is running. For example, us-central1-a.

string zone = 10 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

clone()

public AnywhereCache.Builder clone()
Returns
Type Description
AnywhereCache.Builder
Overrides

getAdmissionPolicy()

public String getAdmissionPolicy()

Cache admission policy. Valid policies includes: admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss. Default value is applied if not specified in the create request.

string admission_policy = 9;

Returns
Type Description
String

The admissionPolicy.

getAdmissionPolicyBytes()

public ByteString getAdmissionPolicyBytes()

Cache admission policy. Valid policies includes: admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss. Default value is applied if not specified in the create request.

string admission_policy = 9;

Returns
Type Description
ByteString

The bytes for admissionPolicy.

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when Anywhere cache instance is allocated.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time when Anywhere cache instance is allocated.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when Anywhere cache instance is allocated.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public AnywhereCache getDefaultInstanceForType()
Returns
Type Description
AnywhereCache

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

Immutable. The resource name of this AnywhereCache. Format: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The resource name of this AnywhereCache. Format: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getPendingUpdate()

public boolean getPendingUpdate()

Output only. True if there is an active update operation against this cache instance. Subsequential update requests will be rejected if this field is true. Output only.

bool pending_update = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The pendingUpdate.

getState()

public String getState()

Output only. Cache state including RUNNING, CREATING, DISABLED and PAUSED.

string state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The state.

getStateBytes()

public ByteString getStateBytes()

Output only. Cache state including RUNNING, CREATING, DISABLED and PAUSED.

string state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for state.

getTtl()

public Duration getTtl()

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

.google.protobuf.Duration ttl = 3;

Returns
Type Description
Duration

The ttl.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

.google.protobuf.Duration ttl = 3;

Returns
Type Description
Builder

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

.google.protobuf.Duration ttl = 3;

Returns
Type Description
DurationOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when Anywhere cache instance is last updated, including creation.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Time when Anywhere cache instance is last updated, including creation.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when Anywhere cache instance is last updated, including creation.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getZone()

public String getZone()

Immutable. The zone in which the cache instance is running. For example, us-central1-a.

string zone = 10 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

Immutable. The zone in which the cache instance is running. For example, us-central1-a.

string zone = 10 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for zone.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when Anywhere cache instance is allocated.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasTtl()

public boolean hasTtl()

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

.google.protobuf.Duration ttl = 3;

Returns
Type Description
boolean

Whether the ttl field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when Anywhere cache instance is last updated, including creation.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public AnywhereCache.Builder mergeCreateTime(Timestamp value)

Output only. Time when Anywhere cache instance is allocated.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
AnywhereCache.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnywhereCache.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnywhereCache.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AnywhereCache.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AnywhereCache.Builder
Overrides

mergeFrom(AnywhereCache other)

public AnywhereCache.Builder mergeFrom(AnywhereCache other)
Parameter
Name Description
other AnywhereCache
Returns
Type Description
AnywhereCache.Builder

mergeTtl(Duration value)

public AnywhereCache.Builder mergeTtl(Duration value)

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

.google.protobuf.Duration ttl = 3;

Parameter
Name Description
value Duration
Returns
Type Description
AnywhereCache.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnywhereCache.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnywhereCache.Builder
Overrides

mergeUpdateTime(Timestamp value)

public AnywhereCache.Builder mergeUpdateTime(Timestamp value)

Output only. Time when Anywhere cache instance is last updated, including creation.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
AnywhereCache.Builder

setAdmissionPolicy(String value)

public AnywhereCache.Builder setAdmissionPolicy(String value)

Cache admission policy. Valid policies includes: admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss. Default value is applied if not specified in the create request.

string admission_policy = 9;

Parameter
Name Description
value String

The admissionPolicy to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

setAdmissionPolicyBytes(ByteString value)

public AnywhereCache.Builder setAdmissionPolicyBytes(ByteString value)

Cache admission policy. Valid policies includes: admit-on-first-miss and admit-on-second-miss. Defaults to admit-on-first-miss. Default value is applied if not specified in the create request.

string admission_policy = 9;

Parameter
Name Description
value ByteString

The bytes for admissionPolicy to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public AnywhereCache.Builder setCreateTime(Timestamp value)

Output only. Time when Anywhere cache instance is allocated.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
AnywhereCache.Builder

setCreateTime(Timestamp.Builder builderForValue)

public AnywhereCache.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when Anywhere cache instance is allocated.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AnywhereCache.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AnywhereCache.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnywhereCache.Builder
Overrides

setName(String value)

public AnywhereCache.Builder setName(String value)

Immutable. The resource name of this AnywhereCache. Format: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AnywhereCache.Builder setNameBytes(ByteString value)

Immutable. The resource name of this AnywhereCache. Format: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

setPendingUpdate(boolean value)

public AnywhereCache.Builder setPendingUpdate(boolean value)

Output only. True if there is an active update operation against this cache instance. Subsequential update requests will be rejected if this field is true. Output only.

bool pending_update = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The pendingUpdate to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AnywhereCache.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AnywhereCache.Builder
Overrides

setState(String value)

public AnywhereCache.Builder setState(String value)

Output only. Cache state including RUNNING, CREATING, DISABLED and PAUSED.

string state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The state to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

setStateBytes(ByteString value)

public AnywhereCache.Builder setStateBytes(ByteString value)

Output only. Cache state including RUNNING, CREATING, DISABLED and PAUSED.

string state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for state to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

setTtl(Duration value)

public AnywhereCache.Builder setTtl(Duration value)

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

.google.protobuf.Duration ttl = 3;

Parameter
Name Description
value Duration
Returns
Type Description
AnywhereCache.Builder

setTtl(Duration.Builder builderForValue)

public AnywhereCache.Builder setTtl(Duration.Builder builderForValue)

Cache entry TTL (ranges between 1h to 7d). This is a cache-level config that defines how long a cache entry can live. Default ttl value (24hrs) is applied if not specified in the create request. TTL must be in whole seconds.

.google.protobuf.Duration ttl = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AnywhereCache.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final AnywhereCache.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnywhereCache.Builder
Overrides

setUpdateTime(Timestamp value)

public AnywhereCache.Builder setUpdateTime(Timestamp value)

Output only. Time when Anywhere cache instance is last updated, including creation.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
AnywhereCache.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public AnywhereCache.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Time when Anywhere cache instance is last updated, including creation.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AnywhereCache.Builder

setZone(String value)

public AnywhereCache.Builder setZone(String value)

Immutable. The zone in which the cache instance is running. For example, us-central1-a.

string zone = 10 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The zone to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public AnywhereCache.Builder setZoneBytes(ByteString value)

Immutable. The zone in which the cache instance is running. For example, us-central1-a.

string zone = 10 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for zone to set.

Returns
Type Description
AnywhereCache.Builder

This builder for chaining.