public static final class CrontabSpec.Builder extends GeneratedMessageV3.Builder<CrontabSpec.Builder> implements CrontabSpecOrBuilderCrontabSpec 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CrontabSpec.BuilderImplements
CrontabSpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CrontabSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
build()
public CrontabSpec build()| Returns | |
|---|---|
| Type | Description |
CrontabSpec |
|
buildPartial()
public CrontabSpec buildPartial()| Returns | |
|---|---|
| Type | Description |
CrontabSpec |
|
clear()
public CrontabSpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
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 | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public CrontabSpec.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CrontabSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
This builder for chaining. |
clone()
public CrontabSpec.Builder clone()| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getDefaultInstanceForType()
public CrontabSpec getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CrontabSpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the creationWindow field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CrontabSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CrontabSpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
mergeFrom(CrontabSpec other)
public CrontabSpec.Builder mergeFrom(CrontabSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
CrontabSpec |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CrontabSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public CrontabSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CrontabSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe text to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for text to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe timeZone to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for timeZone to set. |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CrontabSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CrontabSpec.Builder |
|