Class CreateRapidCacheMetadata.Builder (2.71.0)

public static final class CreateRapidCacheMetadata.Builder extends GeneratedMessage.Builder<CreateRapidCacheMetadata.Builder> implements CreateRapidCacheMetadataOrBuilder

Message returned in the metadata field of the Operation resource for CreateRapidCache operations.

Protobuf type google.storage.control.v2.CreateRapidCacheMetadata

Static Methods

getDescriptor()

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

Methods

build()

public CreateRapidCacheMetadata build()
Returns
Type Description
CreateRapidCacheMetadata

buildPartial()

public CreateRapidCacheMetadata buildPartial()
Returns
Type Description
CreateRapidCacheMetadata

clear()

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

clearAdmissionPolicy()

public CreateRapidCacheMetadata.Builder clearAdmissionPolicy()

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

optional string admission_policy = 5;

Returns
Type Description
CreateRapidCacheMetadata.Builder

This builder for chaining.

clearCacheType()

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

This builder for chaining.

clearCommonMetadata()

public CreateRapidCacheMetadata.Builder clearCommonMetadata()

Generic metadata for the long running operation.

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

Returns
Type Description
CreateRapidCacheMetadata.Builder

clearIngestOnWrite()

public CreateRapidCacheMetadata.Builder clearIngestOnWrite()

Optional. Specifies whether objects are ingested into the cache upon write. Defaults to false.

optional bool ingest_on_write = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateRapidCacheMetadata.Builder

This builder for chaining.

clearRapidCacheId()

public CreateRapidCacheMetadata.Builder clearRapidCacheId()

Rapid Cache ID.

optional string rapid_cache_id = 2;

Returns
Type Description
CreateRapidCacheMetadata.Builder

This builder for chaining.

clearTtl()

public CreateRapidCacheMetadata.Builder clearTtl()

Rapid Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

optional .google.protobuf.Duration ttl = 4;

Returns
Type Description
CreateRapidCacheMetadata.Builder

clearZone()

public CreateRapidCacheMetadata.Builder clearZone()

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

optional string zone = 3;

Returns
Type Description
CreateRapidCacheMetadata.Builder

This builder for chaining.

getAdmissionPolicy()

public String getAdmissionPolicy()

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

optional string admission_policy = 5;

Returns
Type Description
String

The admissionPolicy.

getAdmissionPolicyBytes()

public ByteString getAdmissionPolicyBytes()

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

optional string admission_policy = 5;

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 CreateRapidCacheMetadata getDefaultInstanceForType()
Returns
Type Description
CreateRapidCacheMetadata

getDescriptorForType()

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

getIngestOnWrite()

public boolean getIngestOnWrite()

Optional. Specifies whether objects are ingested into the cache upon write. Defaults to false.

optional bool ingest_on_write = 6 [(.google.api.field_behavior) = OPTIONAL];

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. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

optional .google.protobuf.Duration ttl = 4;

Returns
Type Description
Duration

The ttl.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

Rapid Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

optional .google.protobuf.Duration ttl = 4;

Returns
Type Description
Builder

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

Rapid Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create 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()

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

optional string admission_policy = 5;

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()

Optional. Specifies whether objects are ingested into the cache upon write. Defaults to false.

optional bool ingest_on_write = 6 [(.google.api.field_behavior) = OPTIONAL];

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. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create 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 CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(CreateRapidCacheMetadata other)

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

mergeTtl(Duration value)

public CreateRapidCacheMetadata.Builder mergeTtl(Duration value)

Rapid Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

optional .google.protobuf.Duration ttl = 4;

Parameter
Name Description
value Duration
Returns
Type Description
CreateRapidCacheMetadata.Builder

setAdmissionPolicy(String value)

public CreateRapidCacheMetadata.Builder setAdmissionPolicy(String value)

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

optional string admission_policy = 5;

Parameter
Name Description
value String

The admissionPolicy to set.

Returns
Type Description
CreateRapidCacheMetadata.Builder

This builder for chaining.

setAdmissionPolicyBytes(ByteString value)

public CreateRapidCacheMetadata.Builder setAdmissionPolicyBytes(ByteString value)

Anywhere Cache entry Admission Policy in kebab-case (e.g., "admit-on-first-miss"). Default admission policy (admit-on-first-miss) is applied if not specified in the create request.

optional string admission_policy = 5;

Parameter
Name Description
value ByteString

The bytes for admissionPolicy to set.

Returns
Type Description
CreateRapidCacheMetadata.Builder

This builder for chaining.

setCacheType(String value)

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

This builder for chaining.

setCacheTypeBytes(ByteString value)

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

This builder for chaining.

setCommonMetadata(CommonLongRunningOperationMetadata value)

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

setCommonMetadata(CommonLongRunningOperationMetadata.Builder builderForValue)

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

setIngestOnWrite(boolean value)

public CreateRapidCacheMetadata.Builder setIngestOnWrite(boolean value)

Optional. Specifies whether objects are ingested into the cache upon write. Defaults to false.

optional bool ingest_on_write = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The ingestOnWrite to set.

Returns
Type Description
CreateRapidCacheMetadata.Builder

This builder for chaining.

setRapidCacheId(String value)

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

This builder for chaining.

setRapidCacheIdBytes(ByteString value)

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

This builder for chaining.

setTtl(Duration value)

public CreateRapidCacheMetadata.Builder setTtl(Duration value)

Rapid Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

optional .google.protobuf.Duration ttl = 4;

Parameter
Name Description
value Duration
Returns
Type Description
CreateRapidCacheMetadata.Builder

setTtl(Duration.Builder builderForValue)

public CreateRapidCacheMetadata.Builder setTtl(Duration.Builder builderForValue)

Rapid Cache entry's TTL. A cache-level config that is applied to all new cache entries on admission. Default ttl value (24hrs) is applied if not specified in the create request.

optional .google.protobuf.Duration ttl = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CreateRapidCacheMetadata.Builder

setZone(String value)

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public CreateRapidCacheMetadata.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
CreateRapidCacheMetadata.Builder

This builder for chaining.