- 1.55.0 (latest)
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.0.4
public static final class TransferTypes.TransferJob extends GeneratedMessageV3 implements TransferTypes.TransferJobOrBuilderThis resource represents the configuration of a transfer job that runs periodically.
Protobuf type google.storagetransfer.v1.TransferJob
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.TransferJobImplements
TransferTypes.TransferJobOrBuilderStatic Fields
CREATION_TIME_FIELD_NUMBER
public static final int CREATION_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELETION_TIME_FIELD_NUMBER
public static final int DELETION_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EVENT_STREAM_FIELD_NUMBER
public static final int EVENT_STREAM_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LAST_MODIFICATION_TIME_FIELD_NUMBER
public static final int LAST_MODIFICATION_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LATEST_OPERATION_NAME_FIELD_NUMBER
public static final int LATEST_OPERATION_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LOGGING_CONFIG_FIELD_NUMBER
public static final int LOGGING_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NOTIFICATION_CONFIG_FIELD_NUMBER
public static final int NOTIFICATION_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRANSFER_SPEC_FIELD_NUMBER
public static final int TRANSFER_SPEC_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static TransferTypes.TransferJob getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static TransferTypes.TransferJob.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob.Builder |
|
newBuilder(TransferTypes.TransferJob prototype)
public static TransferTypes.TransferJob.Builder newBuilder(TransferTypes.TransferJob prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
TransferTypes.TransferJob |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob.Builder |
|
parseDelimitedFrom(InputStream input)
public static TransferTypes.TransferJob parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static TransferTypes.TransferJob parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static TransferTypes.TransferJob parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static TransferTypes.TransferJob parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static TransferTypes.TransferJob parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static TransferTypes.TransferJob parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<TransferTypes.TransferJob> parser()| Returns | |
|---|---|
| Type | Description |
Parser<TransferJob> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCreationTime()
public Timestamp getCreationTime()Output only. The time that the transfer job was created.
.google.protobuf.Timestamp creation_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The creationTime. |
getCreationTimeOrBuilder()
public TimestampOrBuilder getCreationTimeOrBuilder()Output only. The time that the transfer job was created.
.google.protobuf.Timestamp creation_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public TransferTypes.TransferJob getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob |
|
getDeletionTime()
public Timestamp getDeletionTime()Output only. The time that the transfer job was deleted.
.google.protobuf.Timestamp deletion_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The deletionTime. |
getDeletionTimeOrBuilder()
public TimestampOrBuilder getDeletionTimeOrBuilder()Output only. The time that the transfer job was deleted.
.google.protobuf.Timestamp deletion_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDescription()
public String getDescription()A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string description = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string description = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getEventStream()
public TransferTypes.EventStream getEventStream()Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
.google.storagetransfer.v1.EventStream event_stream = 15;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.EventStream |
The eventStream. |
getEventStreamOrBuilder()
public TransferTypes.EventStreamOrBuilder getEventStreamOrBuilder()Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
.google.storagetransfer.v1.EventStream event_stream = 15;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.EventStreamOrBuilder |
|
getLastModificationTime()
public Timestamp getLastModificationTime()Output only. The time that the transfer job was last modified.
.google.protobuf.Timestamp last_modification_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The lastModificationTime. |
getLastModificationTimeOrBuilder()
public TimestampOrBuilder getLastModificationTimeOrBuilder()Output only. The time that the transfer job was last modified.
.google.protobuf.Timestamp last_modification_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getLatestOperationName()
public String getLatestOperationName()The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
string latest_operation_name = 12;
| Returns | |
|---|---|
| Type | Description |
String |
The latestOperationName. |
getLatestOperationNameBytes()
public ByteString getLatestOperationNameBytes()The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
string latest_operation_name = 12;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for latestOperationName. |
getLoggingConfig()
public TransferTypes.LoggingConfig getLoggingConfig()Logging configuration.
.google.storagetransfer.v1.LoggingConfig logging_config = 14;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.LoggingConfig |
The loggingConfig. |
getLoggingConfigOrBuilder()
public TransferTypes.LoggingConfigOrBuilder getLoggingConfigOrBuilder()Logging configuration.
.google.storagetransfer.v1.LoggingConfig logging_config = 14;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.LoggingConfigOrBuilder |
|
getName()
public String getName()A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job.
If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error.
This name must start with "transferJobs/" prefix and end with a letter or
a number, and should be no more than 128 characters. For transfers
involving PosixFilesystem, this name must start with transferJobs/OPI
specifically. For all other transfer types, this name must not start with
transferJobs/OPI.
Non-PosixFilesystem example:
"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"
PosixFilesystem example:
"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"
Applications must not rely on the enforcement of naming requirements involving OPI.
Invalid job names fail with an INVALID_ARGUMENT error.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job.
If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error.
This name must start with "transferJobs/" prefix and end with a letter or
a number, and should be no more than 128 characters. For transfers
involving PosixFilesystem, this name must start with transferJobs/OPI
specifically. For all other transfer types, this name must not start with
transferJobs/OPI.
Non-PosixFilesystem example:
"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"
PosixFilesystem example:
"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"
Applications must not rely on the enforcement of naming requirements involving OPI.
Invalid job names fail with an INVALID_ARGUMENT error.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNotificationConfig()
public TransferTypes.NotificationConfig getNotificationConfig()Notification configuration.
.google.storagetransfer.v1.NotificationConfig notification_config = 11;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.NotificationConfig |
The notificationConfig. |
getNotificationConfigOrBuilder()
public TransferTypes.NotificationConfigOrBuilder getNotificationConfigOrBuilder()Notification configuration.
.google.storagetransfer.v1.NotificationConfig notification_config = 11;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.NotificationConfigOrBuilder |
|
getParserForType()
public Parser<TransferTypes.TransferJob> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<TransferJob> |
|
getProjectId()
public String getProjectId()The ID of the Google Cloud project that owns the job.
string project_id = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The projectId. |
getProjectIdBytes()
public ByteString getProjectIdBytes()The ID of the Google Cloud project that owns the job.
string project_id = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for projectId. |
getSchedule()
public TransferTypes.Schedule getSchedule()Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
.google.storagetransfer.v1.Schedule schedule = 5;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule |
The schedule. |
getScheduleOrBuilder()
public TransferTypes.ScheduleOrBuilder getScheduleOrBuilder()Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
.google.storagetransfer.v1.Schedule schedule = 5;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.ScheduleOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getStatus()
public TransferTypes.TransferJob.Status getStatus() Status of the job. This value MUST be specified for
CreateTransferJobRequests.
Note: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.
.google.storagetransfer.v1.TransferJob.Status status = 6;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob.Status |
The status. |
getStatusValue()
public int getStatusValue() Status of the job. This value MUST be specified for
CreateTransferJobRequests.
Note: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.
.google.storagetransfer.v1.TransferJob.Status status = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for status. |
getTransferSpec()
public TransferTypes.TransferSpec getTransferSpec()Transfer specification.
.google.storagetransfer.v1.TransferSpec transfer_spec = 4;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferSpec |
The transferSpec. |
getTransferSpecOrBuilder()
public TransferTypes.TransferSpecOrBuilder getTransferSpecOrBuilder()Transfer specification.
.google.storagetransfer.v1.TransferSpec transfer_spec = 4;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferSpecOrBuilder |
|
hasCreationTime()
public boolean hasCreationTime()Output only. The time that the transfer job was created.
.google.protobuf.Timestamp creation_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the creationTime field is set. |
hasDeletionTime()
public boolean hasDeletionTime()Output only. The time that the transfer job was deleted.
.google.protobuf.Timestamp deletion_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the deletionTime field is set. |
hasEventStream()
public boolean hasEventStream()Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
.google.storagetransfer.v1.EventStream event_stream = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the eventStream field is set. |
hasLastModificationTime()
public boolean hasLastModificationTime()Output only. The time that the transfer job was last modified.
.google.protobuf.Timestamp last_modification_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the lastModificationTime field is set. |
hasLoggingConfig()
public boolean hasLoggingConfig()Logging configuration.
.google.storagetransfer.v1.LoggingConfig logging_config = 14;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the loggingConfig field is set. |
hasNotificationConfig()
public boolean hasNotificationConfig()Notification configuration.
.google.storagetransfer.v1.NotificationConfig notification_config = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the notificationConfig field is set. |
hasSchedule()
public boolean hasSchedule()Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
.google.storagetransfer.v1.Schedule schedule = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the schedule field is set. |
hasTransferSpec()
public boolean hasTransferSpec()Transfer specification.
.google.storagetransfer.v1.TransferSpec transfer_spec = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the transferSpec field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public TransferTypes.TransferJob.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferTypes.TransferJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public TransferTypes.TransferJob.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
TransferTypes.TransferJob.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|