Class CacheParameters (0.61.0)

public final class CacheParameters extends GeneratedMessageV3 implements CacheParametersOrBuilder

Cache Parameters for the volume.

Protobuf type google.cloud.netapp.v1.CacheParameters

Static Fields

CACHE_CONFIG_FIELD_NUMBER

public static final int CACHE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CACHE_STATE_FIELD_NUMBER

public static final int CACHE_STATE_FIELD_NUMBER
Field Value
Type Description
int

COMMAND_FIELD_NUMBER

public static final int COMMAND_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_GLOBAL_FILE_LOCK_FIELD_NUMBER

public static final int ENABLE_GLOBAL_FILE_LOCK_FIELD_NUMBER
Field Value
Type Description
int

PASSPHRASE_FIELD_NUMBER

public static final int PASSPHRASE_FIELD_NUMBER
Field Value
Type Description
int

PEERING_COMMAND_EXPIRY_TIME_FIELD_NUMBER

public static final int PEERING_COMMAND_EXPIRY_TIME_FIELD_NUMBER
Field Value
Type Description
int

PEER_CLUSTER_NAME_FIELD_NUMBER

public static final int PEER_CLUSTER_NAME_FIELD_NUMBER
Field Value
Type Description
int

PEER_IP_ADDRESSES_FIELD_NUMBER

public static final int PEER_IP_ADDRESSES_FIELD_NUMBER
Field Value
Type Description
int

PEER_SVM_NAME_FIELD_NUMBER

public static final int PEER_SVM_NAME_FIELD_NUMBER
Field Value
Type Description
int

PEER_VOLUME_NAME_FIELD_NUMBER

public static final int PEER_VOLUME_NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_DETAILS_FIELD_NUMBER

public static final int STATE_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CacheParameters getDefaultInstance()
Returns
Type Description
CacheParameters

getDescriptor()

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

newBuilder()

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

newBuilder(CacheParameters prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCacheConfig()

public CacheConfig getCacheConfig()

Optional. Configuration of the cache volume.

.google.cloud.netapp.v1.CacheConfig cache_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CacheConfig

The cacheConfig.

getCacheConfigOrBuilder()

public CacheConfigOrBuilder getCacheConfigOrBuilder()

Optional. Configuration of the cache volume.

.google.cloud.netapp.v1.CacheConfig cache_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CacheConfigOrBuilder

getCacheState()

public CacheParameters.CacheState getCacheState()

Output only. State of the cache volume indicating the peering status.

.google.cloud.netapp.v1.CacheParameters.CacheState cache_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CacheParameters.CacheState

The cacheState.

getCacheStateValue()

public int getCacheStateValue()

Output only. State of the cache volume indicating the peering status.

.google.cloud.netapp.v1.CacheParameters.CacheState cache_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for cacheState.

getCommand()

public String getCommand()

Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.

string command = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The command.

getCommandBytes()

public ByteString getCommandBytes()

Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.

string command = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for command.

getDefaultInstanceForType()

public CacheParameters getDefaultInstanceForType()
Returns
Type Description
CacheParameters

getEnableGlobalFileLock()

public boolean getEnableGlobalFileLock()

Optional. Indicates whether the cache volume has global file lock enabled.

optional bool enable_global_file_lock = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableGlobalFileLock.

getParserForType()

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

getPassphrase()

public String getPassphrase()

Output only. Temporary passphrase generated to accept cluster peering command.

string passphrase = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The passphrase.

getPassphraseBytes()

public ByteString getPassphraseBytes()

Output only. Temporary passphrase generated to accept cluster peering command.

string passphrase = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for passphrase.

getPeerClusterName()

public String getPeerClusterName()

Required. Name of the origin volume's ONTAP cluster.

string peer_cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The peerClusterName.

getPeerClusterNameBytes()

public ByteString getPeerClusterNameBytes()

Required. Name of the origin volume's ONTAP cluster.

string peer_cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for peerClusterName.

getPeerIpAddresses(int index)

public String getPeerIpAddresses(int index)

Required. List of IC LIF addresses of the origin volume's ONTAP cluster.

repeated string peer_ip_addresses = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The peerIpAddresses at the given index.

getPeerIpAddressesBytes(int index)

public ByteString getPeerIpAddressesBytes(int index)

Required. List of IC LIF addresses of the origin volume's ONTAP cluster.

repeated string peer_ip_addresses = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the peerIpAddresses at the given index.

getPeerIpAddressesCount()

public int getPeerIpAddressesCount()

Required. List of IC LIF addresses of the origin volume's ONTAP cluster.

repeated string peer_ip_addresses = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of peerIpAddresses.

getPeerIpAddressesList()

public ProtocolStringList getPeerIpAddressesList()

Required. List of IC LIF addresses of the origin volume's ONTAP cluster.

repeated string peer_ip_addresses = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the peerIpAddresses.

getPeerSvmName()

public String getPeerSvmName()

Required. Name of the origin volume's SVM.

string peer_svm_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The peerSvmName.

getPeerSvmNameBytes()

public ByteString getPeerSvmNameBytes()

Required. Name of the origin volume's SVM.

string peer_svm_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for peerSvmName.

getPeerVolumeName()

public String getPeerVolumeName()

Required. Name of the origin volume for the cache volume.

string peer_volume_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The peerVolumeName.

getPeerVolumeNameBytes()

public ByteString getPeerVolumeNameBytes()

Required. Name of the origin volume for the cache volume.

string peer_volume_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for peerVolumeName.

getPeeringCommandExpiryTime()

public Timestamp getPeeringCommandExpiryTime()

Optional. Expiration time for the peering command to be executed on user's ONTAP.

.google.protobuf.Timestamp peering_command_expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The peeringCommandExpiryTime.

getPeeringCommandExpiryTimeOrBuilder()

public TimestampOrBuilder getPeeringCommandExpiryTimeOrBuilder()

Optional. Expiration time for the peering command to be executed on user's ONTAP.

.google.protobuf.Timestamp peering_command_expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStateDetails()

public String getStateDetails()

Output only. Detailed description of the current cache state.

string state_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The stateDetails.

getStateDetailsBytes()

public ByteString getStateDetailsBytes()

Output only. Detailed description of the current cache state.

string state_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for stateDetails.

hasCacheConfig()

public boolean hasCacheConfig()

Optional. Configuration of the cache volume.

.google.cloud.netapp.v1.CacheConfig cache_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the cacheConfig field is set.

hasEnableGlobalFileLock()

public boolean hasEnableGlobalFileLock()

Optional. Indicates whether the cache volume has global file lock enabled.

optional bool enable_global_file_lock = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the enableGlobalFileLock field is set.

hasPeeringCommandExpiryTime()

public boolean hasPeeringCommandExpiryTime()

Optional. Expiration time for the peering command to be executed on user's ONTAP.

.google.protobuf.Timestamp peering_command_expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the peeringCommandExpiryTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CacheParameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CacheParameters.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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