Interface TransferProto.UpdateTransferJobRequestOrBuilder (1.18.0)

public static interface TransferProto.UpdateTransferJobRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getJobName()

public abstract String getJobName()

Required. The name of job to update.

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

Returns
TypeDescription
String

The jobName.

getJobNameBytes()

public abstract ByteString getJobNameBytes()

Required. The name of job to update.

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

Returns
TypeDescription
ByteString

The bytes for jobName.

getProjectId()

public abstract String getProjectId()

Required. The ID of the Google Cloud project that owns the job.

string project_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

Required. The ID of the Google Cloud project that owns the job.

string project_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for projectId.

getTransferJob()

public abstract TransferTypes.TransferJob getTransferJob()

Required. The job to update. transferJob is expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. An UpdateTransferJobRequest that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires storagetransfer.jobs.delete permission.

.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TransferTypes.TransferJob

The transferJob.

getTransferJobOrBuilder()

public abstract TransferTypes.TransferJobOrBuilder getTransferJobOrBuilder()

Required. The job to update. transferJob is expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. An UpdateTransferJobRequest that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires storagetransfer.jobs.delete permission.

.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TransferTypes.TransferJobOrBuilder

getUpdateTransferJobFieldMask()

public abstract FieldMask getUpdateTransferJobFieldMask()

The field mask of the fields in transferJob that are to be updated in this request. Fields in transferJob that can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update the transfer_spec of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.

.google.protobuf.FieldMask update_transfer_job_field_mask = 4;

Returns
TypeDescription
FieldMask

The updateTransferJobFieldMask.

getUpdateTransferJobFieldMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateTransferJobFieldMaskOrBuilder()

The field mask of the fields in transferJob that are to be updated in this request. Fields in transferJob that can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update the transfer_spec of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.

.google.protobuf.FieldMask update_transfer_job_field_mask = 4;

Returns
TypeDescription
FieldMaskOrBuilder

hasTransferJob()

public abstract boolean hasTransferJob()

Required. The job to update. transferJob is expected to specify one or more of five fields: description, transfer_spec, notification_config, logging_config, and status. An UpdateTransferJobRequest that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires storagetransfer.jobs.delete permission.

.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the transferJob field is set.

hasUpdateTransferJobFieldMask()

public abstract boolean hasUpdateTransferJobFieldMask()

The field mask of the fields in transferJob that are to be updated in this request. Fields in transferJob that can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update the transfer_spec of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.

.google.protobuf.FieldMask update_transfer_job_field_mask = 4;

Returns
TypeDescription
boolean

Whether the updateTransferJobFieldMask field is set.