public static final class TransferTypes.TransferJob extends GeneratedMessageV3 implements TransferTypes.TransferJobOrBuilder
This resource represents the configuration of a transfer job that runs
periodically.
Protobuf type google.storagetransfer.v1.TransferJob
Static 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 |
|
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TransferTypes.TransferJob.Builder newBuilder()
newBuilder(TransferTypes.TransferJob prototype)
public static TransferTypes.TransferJob.Builder newBuilder(TransferTypes.TransferJob prototype)
public static TransferTypes.TransferJob parseDelimitedFrom(InputStream input)
public static TransferTypes.TransferJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TransferTypes.TransferJob parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TransferTypes.TransferJob parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(CodedInputStream input)
public static TransferTypes.TransferJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(InputStream input)
public static TransferTypes.TransferJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TransferTypes.TransferJob parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TransferTypes.TransferJob> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
getDefaultInstanceForType()
public TransferTypes.TransferJob getDefaultInstanceForType()
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];
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.
|
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];
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;
getLoggingConfigOrBuilder()
public TransferTypes.LoggingConfigOrBuilder getLoggingConfigOrBuilder()
Logging configuration.
.google.storagetransfer.v1.LoggingConfig logging_config = 14;
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. This is not supported for transfers involving
PosixFilesystem.
.google.storagetransfer.v1.NotificationConfig notification_config = 11;
getNotificationConfigOrBuilder()
public TransferTypes.NotificationConfigOrBuilder getNotificationConfigOrBuilder()
Notification configuration. This is not supported for transfers involving
PosixFilesystem.
.google.storagetransfer.v1.NotificationConfig notification_config = 11;
getParserForType()
public Parser<TransferTypes.TransferJob> getParserForType()
Overrides
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;
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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;
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;
getTransferSpecOrBuilder()
public TransferTypes.TransferSpecOrBuilder getTransferSpecOrBuilder()
Transfer specification.
.google.storagetransfer.v1.TransferSpec transfer_spec = 4;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
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. This is not supported for transfers involving
PosixFilesystem.
.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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TransferTypes.TransferJob.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferTypes.TransferJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TransferTypes.TransferJob.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
