Class CreateRapidCacheMetadata (2.71.0)

public final class CreateRapidCacheMetadata extends GeneratedMessage implements CreateRapidCacheMetadataOrBuilder

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

Protobuf type google.storage.control.v2.CreateRapidCacheMetadata

Static Fields

ADMISSION_POLICY_FIELD_NUMBER

public static final int ADMISSION_POLICY_FIELD_NUMBER
Field Value
Type Description
int

CACHE_TYPE_FIELD_NUMBER

public static final int CACHE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

COMMON_METADATA_FIELD_NUMBER

public static final int COMMON_METADATA_FIELD_NUMBER
Field Value
Type Description
int

INGEST_ON_WRITE_FIELD_NUMBER

public static final int INGEST_ON_WRITE_FIELD_NUMBER
Field Value
Type Description
int

RAPID_CACHE_ID_FIELD_NUMBER

public static final int RAPID_CACHE_ID_FIELD_NUMBER
Field Value
Type Description
int

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateRapidCacheMetadata getDefaultInstance()
Returns
Type Description
CreateRapidCacheMetadata

getDescriptor()

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

newBuilder()

public static CreateRapidCacheMetadata.Builder newBuilder()
Returns
Type Description
CreateRapidCacheMetadata.Builder

newBuilder(CreateRapidCacheMetadata prototype)

public static CreateRapidCacheMetadata.Builder newBuilder(CreateRapidCacheMetadata prototype)
Parameter
Name Description
prototype CreateRapidCacheMetadata
Returns
Type Description
CreateRapidCacheMetadata.Builder

parseDelimitedFrom(InputStream input)

public static CreateRapidCacheMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRapidCacheMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateRapidCacheMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateRapidCacheMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateRapidCacheMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateRapidCacheMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateRapidCacheMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRapidCacheMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateRapidCacheMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateRapidCacheMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateRapidCacheMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateRapidCacheMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateRapidCacheMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateRapidCacheMetadata> parser()
Returns
Type Description
Parser<CreateRapidCacheMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

getParserForType()

public Parser<CreateRapidCacheMetadata> getParserForType()
Returns
Type Description
Parser<CreateRapidCacheMetadata>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateRapidCacheMetadata.Builder newBuilderForType()
Returns
Type Description
CreateRapidCacheMetadata.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CreateRapidCacheMetadata.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateRapidCacheMetadata.Builder
Overrides

toBuilder()

public CreateRapidCacheMetadata.Builder toBuilder()
Returns
Type Description
CreateRapidCacheMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException