Class BackupPolicy (0.23.0)

public final class BackupPolicy extends GeneratedMessageV3 implements BackupPolicyOrBuilder

Backup Policy.

Protobuf type google.cloud.netapp.v1.BackupPolicy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BackupPolicy

Static Fields

ASSIGNED_VOLUME_COUNT_FIELD_NUMBER

public static final int ASSIGNED_VOLUME_COUNT_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DAILY_BACKUP_LIMIT_FIELD_NUMBER

public static final int DAILY_BACKUP_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MONTHLY_BACKUP_LIMIT_FIELD_NUMBER

public static final int MONTHLY_BACKUP_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

WEEKLY_BACKUP_LIMIT_FIELD_NUMBER

public static final int WEEKLY_BACKUP_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackupPolicy getDefaultInstance()
Returns
Type Description
BackupPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(BackupPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getAssignedVolumeCount()

public int getAssignedVolumeCount()

Output only. The total number of volumes assigned by this backup policy.

optional int32 assigned_volume_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The assignedVolumeCount.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the backup policy was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the backup policy was created.

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

Returns
Type Description
TimestampOrBuilder

getDailyBackupLimit()

public int getDailyBackupLimit()

Number of daily backups to keep. Note that the minimum daily backup limit is 2.

optional int32 daily_backup_limit = 2;

Returns
Type Description
int

The dailyBackupLimit.

getDefaultInstanceForType()

public BackupPolicy getDefaultInstanceForType()
Returns
Type Description
BackupPolicy

getDescription()

public String getDescription()

Description of the backup policy.

optional string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the backup policy.

optional string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getEnabled()

public boolean getEnabled()

If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.

optional bool enabled = 6;

Returns
Type Description
boolean

The enabled.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
String

getMonthlyBackupLimit()

public int getMonthlyBackupLimit()

Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

optional int32 monthly_backup_limit = 4;

Returns
Type Description
int

The monthlyBackupLimit.

getName()

public String getName()

Identifier. The resource name of the backup policy. Format: projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the backup policy. Format: projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public BackupPolicy.State getState()

Output only. The backup policy state.

.google.cloud.netapp.v1.BackupPolicy.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupPolicy.State

The state.

getStateValue()

public int getStateValue()

Output only. The backup policy state.

.google.cloud.netapp.v1.BackupPolicy.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getWeeklyBackupLimit()

public int getWeeklyBackupLimit()

Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

optional int32 weekly_backup_limit = 3;

Returns
Type Description
int

The weeklyBackupLimit.

hasAssignedVolumeCount()

public boolean hasAssignedVolumeCount()

Output only. The total number of volumes assigned by this backup policy.

optional int32 assigned_volume_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the assignedVolumeCount field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the backup policy was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDailyBackupLimit()

public boolean hasDailyBackupLimit()

Number of daily backups to keep. Note that the minimum daily backup limit is 2.

optional int32 daily_backup_limit = 2;

Returns
Type Description
boolean

Whether the dailyBackupLimit field is set.

hasDescription()

public boolean hasDescription()

Description of the backup policy.

optional string description = 5;

Returns
Type Description
boolean

Whether the description field is set.

hasEnabled()

public boolean hasEnabled()

If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.

optional bool enabled = 6;

Returns
Type Description
boolean

Whether the enabled field is set.

hasMonthlyBackupLimit()

public boolean hasMonthlyBackupLimit()

Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

optional int32 monthly_backup_limit = 4;

Returns
Type Description
boolean

Whether the monthlyBackupLimit field is set.

hasWeeklyBackupLimit()

public boolean hasWeeklyBackupLimit()

Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

optional int32 weekly_backup_limit = 3;

Returns
Type Description
boolean

Whether the weeklyBackupLimit field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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