Class UpdateRapidCacheMetadata.Builder (2.71.0)

public static final class UpdateRapidCacheMetadata.Builder extends GeneratedMessage.Builder<UpdateRapidCacheMetadata.Builder> implements UpdateRapidCacheMetadataOrBuilder

Message returned in the metadata field of the Operation resource for UpdateRapidCache operation.

Protobuf type google.storage.control.v2.UpdateRapidCacheMetadata

Static Methods

getDescriptor()

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

Methods

build()

public UpdateRapidCacheMetadata build()
Returns
Type Description
UpdateRapidCacheMetadata

buildPartial()

public UpdateRapidCacheMetadata buildPartial()
Returns
Type Description
UpdateRapidCacheMetadata

clear()

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

clearAdmissionPolicy()

public UpdateRapidCacheMetadata.Builder clearAdmissionPolicy()

Optional. Rapid Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). If admission_policy is pending update, this field equals to the new value specified in the Update request.

optional string admission_policy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

clearCacheType()

public UpdateRapidCacheMetadata.Builder clearCacheType()

Optional. The type of cache. Either rapid cache or rapid cache ultra.

optional string cache_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

clearCommonMetadata()

public UpdateRapidCacheMetadata.Builder clearCommonMetadata()

Generic metadata for the long running operation.

.google.storage.control.v2.CommonLongRunningOperationMetadata common_metadata = 1;

Returns
Type Description
UpdateRapidCacheMetadata.Builder

clearIngestOnWrite()

public UpdateRapidCacheMetadata.Builder clearIngestOnWrite()

Specifies whether objects are ingested into the cache upon write. If not set, it defaults to false.

optional bool ingest_on_write = 6;

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

clearRapidCacheId()

public UpdateRapidCacheMetadata.Builder clearRapidCacheId()

Rapid Cache ID.

optional string rapid_cache_id = 2;

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

clearTtl()

public UpdateRapidCacheMetadata.Builder clearTtl()

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

optional .google.protobuf.Duration ttl = 4;

Returns
Type Description
UpdateRapidCacheMetadata.Builder

clearZone()

public UpdateRapidCacheMetadata.Builder clearZone()

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

optional string zone = 3;

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

getAdmissionPolicy()

public String getAdmissionPolicy()

Optional. Rapid Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). If admission_policy is pending update, this field equals to the new value specified in the Update request.

optional string admission_policy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The admissionPolicy.

getAdmissionPolicyBytes()

public ByteString getAdmissionPolicyBytes()

Optional. Rapid Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). If admission_policy is pending update, this field equals to the new value specified in the Update request.

optional string admission_policy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for admissionPolicy.

getCacheType()

public String getCacheType()

Optional. The type of cache. Either rapid cache or rapid cache ultra.

optional string cache_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cacheType.

getCacheTypeBytes()

public ByteString getCacheTypeBytes()

Optional. The type of cache. Either rapid cache or rapid cache ultra.

optional string cache_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cacheType.

getCommonMetadata()

public CommonLongRunningOperationMetadata getCommonMetadata()

Generic metadata for the long running operation.

.google.storage.control.v2.CommonLongRunningOperationMetadata common_metadata = 1;

Returns
Type Description
CommonLongRunningOperationMetadata

The commonMetadata.

getCommonMetadataBuilder()

public CommonLongRunningOperationMetadata.Builder getCommonMetadataBuilder()

Generic metadata for the long running operation.

.google.storage.control.v2.CommonLongRunningOperationMetadata common_metadata = 1;

Returns
Type Description
CommonLongRunningOperationMetadata.Builder

getCommonMetadataOrBuilder()

public CommonLongRunningOperationMetadataOrBuilder getCommonMetadataOrBuilder()

Generic metadata for the long running operation.

.google.storage.control.v2.CommonLongRunningOperationMetadata common_metadata = 1;

Returns
Type Description
CommonLongRunningOperationMetadataOrBuilder

getDefaultInstanceForType()

public UpdateRapidCacheMetadata getDefaultInstanceForType()
Returns
Type Description
UpdateRapidCacheMetadata

getDescriptorForType()

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

getIngestOnWrite()

public boolean getIngestOnWrite()

Specifies whether objects are ingested into the cache upon write. If not set, it defaults to false.

optional bool ingest_on_write = 6;

Returns
Type Description
boolean

The ingestOnWrite.

getRapidCacheId()

public String getRapidCacheId()

Rapid Cache ID.

optional string rapid_cache_id = 2;

Returns
Type Description
String

The rapidCacheId.

getRapidCacheIdBytes()

public ByteString getRapidCacheIdBytes()

Rapid Cache ID.

optional string rapid_cache_id = 2;

Returns
Type Description
ByteString

The bytes for rapidCacheId.

getTtl()

public Duration getTtl()

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

optional .google.protobuf.Duration ttl = 4;

Returns
Type Description
Duration

The ttl.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

optional .google.protobuf.Duration ttl = 4;

Returns
Type Description
Builder

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

optional .google.protobuf.Duration ttl = 4;

Returns
Type Description
DurationOrBuilder

getZone()

public String getZone()

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

optional string zone = 3;

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

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

optional string zone = 3;

Returns
Type Description
ByteString

The bytes for zone.

hasAdmissionPolicy()

public boolean hasAdmissionPolicy()

Optional. Rapid Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). If admission_policy is pending update, this field equals to the new value specified in the Update request.

optional string admission_policy = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the admissionPolicy field is set.

hasCacheType()

public boolean hasCacheType()

Optional. The type of cache. Either rapid cache or rapid cache ultra.

optional string cache_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the cacheType field is set.

hasCommonMetadata()

public boolean hasCommonMetadata()

Generic metadata for the long running operation.

.google.storage.control.v2.CommonLongRunningOperationMetadata common_metadata = 1;

Returns
Type Description
boolean

Whether the commonMetadata field is set.

hasIngestOnWrite()

public boolean hasIngestOnWrite()

Specifies whether objects are ingested into the cache upon write. If not set, it defaults to false.

optional bool ingest_on_write = 6;

Returns
Type Description
boolean

Whether the ingestOnWrite field is set.

hasRapidCacheId()

public boolean hasRapidCacheId()

Rapid Cache ID.

optional string rapid_cache_id = 2;

Returns
Type Description
boolean

Whether the rapidCacheId field is set.

hasTtl()

public boolean hasTtl()

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

optional .google.protobuf.Duration ttl = 4;

Returns
Type Description
boolean

Whether the ttl field is set.

hasZone()

public boolean hasZone()

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

optional string zone = 3;

Returns
Type Description
boolean

Whether the zone field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommonMetadata(CommonLongRunningOperationMetadata value)

public UpdateRapidCacheMetadata.Builder mergeCommonMetadata(CommonLongRunningOperationMetadata value)

Generic metadata for the long running operation.

.google.storage.control.v2.CommonLongRunningOperationMetadata common_metadata = 1;

Parameter
Name Description
value CommonLongRunningOperationMetadata
Returns
Type Description
UpdateRapidCacheMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(UpdateRapidCacheMetadata other)

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

mergeTtl(Duration value)

public UpdateRapidCacheMetadata.Builder mergeTtl(Duration value)

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

optional .google.protobuf.Duration ttl = 4;

Parameter
Name Description
value Duration
Returns
Type Description
UpdateRapidCacheMetadata.Builder

setAdmissionPolicy(String value)

public UpdateRapidCacheMetadata.Builder setAdmissionPolicy(String value)

Optional. Rapid Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). If admission_policy is pending update, this field equals to the new value specified in the Update request.

optional string admission_policy = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The admissionPolicy to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

setAdmissionPolicyBytes(ByteString value)

public UpdateRapidCacheMetadata.Builder setAdmissionPolicyBytes(ByteString value)

Optional. Rapid Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). If admission_policy is pending update, this field equals to the new value specified in the Update request.

optional string admission_policy = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for admissionPolicy to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

setCacheType(String value)

public UpdateRapidCacheMetadata.Builder setCacheType(String value)

Optional. The type of cache. Either rapid cache or rapid cache ultra.

optional string cache_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The cacheType to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

setCacheTypeBytes(ByteString value)

public UpdateRapidCacheMetadata.Builder setCacheTypeBytes(ByteString value)

Optional. The type of cache. Either rapid cache or rapid cache ultra.

optional string cache_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for cacheType to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

setCommonMetadata(CommonLongRunningOperationMetadata value)

public UpdateRapidCacheMetadata.Builder setCommonMetadata(CommonLongRunningOperationMetadata value)

Generic metadata for the long running operation.

.google.storage.control.v2.CommonLongRunningOperationMetadata common_metadata = 1;

Parameter
Name Description
value CommonLongRunningOperationMetadata
Returns
Type Description
UpdateRapidCacheMetadata.Builder

setCommonMetadata(CommonLongRunningOperationMetadata.Builder builderForValue)

public UpdateRapidCacheMetadata.Builder setCommonMetadata(CommonLongRunningOperationMetadata.Builder builderForValue)

Generic metadata for the long running operation.

.google.storage.control.v2.CommonLongRunningOperationMetadata common_metadata = 1;

Parameter
Name Description
builderForValue CommonLongRunningOperationMetadata.Builder
Returns
Type Description
UpdateRapidCacheMetadata.Builder

setIngestOnWrite(boolean value)

public UpdateRapidCacheMetadata.Builder setIngestOnWrite(boolean value)

Specifies whether objects are ingested into the cache upon write. If not set, it defaults to false.

optional bool ingest_on_write = 6;

Parameter
Name Description
value boolean

The ingestOnWrite to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

setRapidCacheId(String value)

public UpdateRapidCacheMetadata.Builder setRapidCacheId(String value)

Rapid Cache ID.

optional string rapid_cache_id = 2;

Parameter
Name Description
value String

The rapidCacheId to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

setRapidCacheIdBytes(ByteString value)

public UpdateRapidCacheMetadata.Builder setRapidCacheIdBytes(ByteString value)

Rapid Cache ID.

optional string rapid_cache_id = 2;

Parameter
Name Description
value ByteString

The bytes for rapidCacheId to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

setTtl(Duration value)

public UpdateRapidCacheMetadata.Builder setTtl(Duration value)

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

optional .google.protobuf.Duration ttl = 4;

Parameter
Name Description
value Duration
Returns
Type Description
UpdateRapidCacheMetadata.Builder

setTtl(Duration.Builder builderForValue)

public UpdateRapidCacheMetadata.Builder setTtl(Duration.Builder builderForValue)

Rapid Cache entry's TTL between 1h and 7days. A cache-level config that is applied to all new cache entries on admission. If ttl is pending update, this field equals to the new value specified in the Update request.

optional .google.protobuf.Duration ttl = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateRapidCacheMetadata.Builder

setZone(String value)

public UpdateRapidCacheMetadata.Builder setZone(String value)

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

optional string zone = 3;

Parameter
Name Description
value String

The zone to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public UpdateRapidCacheMetadata.Builder setZoneBytes(ByteString value)

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

optional string zone = 3;

Parameter
Name Description
value ByteString

The bytes for zone to set.

Returns
Type Description
UpdateRapidCacheMetadata.Builder

This builder for chaining.