Class CrontabSpec.Builder (6.85.0)

public static final class CrontabSpec.Builder extends GeneratedMessageV3.Builder<CrontabSpec.Builder> implements CrontabSpecOrBuilder

CrontabSpec can be used to specify the version time and frequency at which the backup should be created.

Protobuf type google.spanner.admin.database.v1.CrontabSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CrontabSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CrontabSpec.Builder
Overrides

build()

public CrontabSpec build()
Returns
TypeDescription
CrontabSpec

buildPartial()

public CrontabSpec buildPartial()
Returns
TypeDescription
CrontabSpec

clear()

public CrontabSpec.Builder clear()
Returns
TypeDescription
CrontabSpec.Builder
Overrides

clearCreationWindow()

public CrontabSpec.Builder clearCreationWindow()

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec.cron_spec and version_time + creation_window.

.google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CrontabSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public CrontabSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CrontabSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CrontabSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CrontabSpec.Builder
Overrides

clearText()

public CrontabSpec.Builder clearText()

Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone.

The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications:

  • 0 2/12 * * * : every 12 hours at (2, 14) hours past midnight in UTC.
  • 0 2,14 * * * : every 12 hours at (2,14) hours past midnight in UTC.
  • 0 2 * * * : once a day at 2 past midnight in UTC.
  • 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC.
  • 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC.

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

Returns
TypeDescription
CrontabSpec.Builder

This builder for chaining.

clearTimeZone()

public CrontabSpec.Builder clearTimeZone()

Output only. The time zone of the times in CrontabSpec.text. Currently only UTC is supported.

string time_zone = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CrontabSpec.Builder

This builder for chaining.

clone()

public CrontabSpec.Builder clone()
Returns
TypeDescription
CrontabSpec.Builder
Overrides

getCreationWindow()

public Duration getCreationWindow()

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec.cron_spec and version_time + creation_window.

.google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Duration

The creationWindow.

getCreationWindowBuilder()

public Duration.Builder getCreationWindowBuilder()

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec.cron_spec and version_time + creation_window.

.google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getCreationWindowOrBuilder()

public DurationOrBuilder getCreationWindowOrBuilder()

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec.cron_spec and version_time + creation_window.

.google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DurationOrBuilder

getDefaultInstanceForType()

public CrontabSpec getDefaultInstanceForType()
Returns
TypeDescription
CrontabSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getText()

public String getText()

Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone.

The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications:

  • 0 2/12 * * * : every 12 hours at (2, 14) hours past midnight in UTC.
  • 0 2,14 * * * : every 12 hours at (2,14) hours past midnight in UTC.
  • 0 2 * * * : once a day at 2 past midnight in UTC.
  • 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC.
  • 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC.

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

Returns
TypeDescription
String

The text.

getTextBytes()

public ByteString getTextBytes()

Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone.

The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications:

  • 0 2/12 * * * : every 12 hours at (2, 14) hours past midnight in UTC.
  • 0 2,14 * * * : every 12 hours at (2,14) hours past midnight in UTC.
  • 0 2 * * * : once a day at 2 past midnight in UTC.
  • 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC.
  • 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC.

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

Returns
TypeDescription
ByteString

The bytes for text.

getTimeZone()

public String getTimeZone()

Output only. The time zone of the times in CrontabSpec.text. Currently only UTC is supported.

string time_zone = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

Output only. The time zone of the times in CrontabSpec.text. Currently only UTC is supported.

string time_zone = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for timeZone.

hasCreationWindow()

public boolean hasCreationWindow()

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec.cron_spec and version_time + creation_window.

.google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the creationWindow field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreationWindow(Duration value)

public CrontabSpec.Builder mergeCreationWindow(Duration value)

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec.cron_spec and version_time + creation_window.

.google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueDuration
Returns
TypeDescription
CrontabSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CrontabSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CrontabSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CrontabSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CrontabSpec.Builder
Overrides

mergeFrom(CrontabSpec other)

public CrontabSpec.Builder mergeFrom(CrontabSpec other)
Parameter
NameDescription
otherCrontabSpec
Returns
TypeDescription
CrontabSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CrontabSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CrontabSpec.Builder
Overrides

setCreationWindow(Duration value)

public CrontabSpec.Builder setCreationWindow(Duration value)

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec.cron_spec and version_time + creation_window.

.google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueDuration
Returns
TypeDescription
CrontabSpec.Builder

setCreationWindow(Duration.Builder builderForValue)

public CrontabSpec.Builder setCreationWindow(Duration.Builder builderForValue)

Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in schedule_spec.cron_spec. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in schedule_spec.cron_spec and version_time + creation_window.

.google.protobuf.Duration creation_window = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
CrontabSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CrontabSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CrontabSpec.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CrontabSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CrontabSpec.Builder
Overrides

setText(String value)

public CrontabSpec.Builder setText(String value)

Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone.

The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications:

  • 0 2/12 * * * : every 12 hours at (2, 14) hours past midnight in UTC.
  • 0 2,14 * * * : every 12 hours at (2,14) hours past midnight in UTC.
  • 0 2 * * * : once a day at 2 past midnight in UTC.
  • 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC.
  • 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC.

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

Parameter
NameDescription
valueString

The text to set.

Returns
TypeDescription
CrontabSpec.Builder

This builder for chaining.

setTextBytes(ByteString value)

public CrontabSpec.Builder setTextBytes(ByteString value)

Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone.

The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications:

  • 0 2/12 * * * : every 12 hours at (2, 14) hours past midnight in UTC.
  • 0 2,14 * * * : every 12 hours at (2,14) hours past midnight in UTC.
  • 0 2 * * * : once a day at 2 past midnight in UTC.
  • 0 2 * * 0 : once a week every Sunday at 2 past midnight in UTC.
  • 0 2 8 * * : once a month on 8th day at 2 past midnight in UTC.

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

Parameter
NameDescription
valueByteString

The bytes for text to set.

Returns
TypeDescription
CrontabSpec.Builder

This builder for chaining.

setTimeZone(String value)

public CrontabSpec.Builder setTimeZone(String value)

Output only. The time zone of the times in CrontabSpec.text. Currently only UTC is supported.

string time_zone = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The timeZone to set.

Returns
TypeDescription
CrontabSpec.Builder

This builder for chaining.

setTimeZoneBytes(ByteString value)

public CrontabSpec.Builder setTimeZoneBytes(ByteString value)

Output only. The time zone of the times in CrontabSpec.text. Currently only UTC is supported.

string time_zone = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for timeZone to set.

Returns
TypeDescription
CrontabSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CrontabSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CrontabSpec.Builder
Overrides