Interface TransferProto.UpdateTransferJobRequestOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
TransferProto.UpdateTransferJobRequest
,TransferProto.UpdateTransferJobRequest.Builder
- Enclosing class:
- TransferProto
public static interface TransferProto.UpdateTransferJobRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getJobName()
Required.com.google.protobuf.ByteString
getJobNameBytes()
Required.String
getProjectId()
Required.com.google.protobuf.ByteString
getProjectIdBytes()
Required.TransferTypes.TransferJob
getTransferJob()
Required.TransferTypes.TransferJobOrBuilder
getTransferJobOrBuilder()
Required.com.google.protobuf.FieldMask
getUpdateTransferJobFieldMask()
The field mask of the fields in `transferJob` that are to be updated in this request.com.google.protobuf.FieldMaskOrBuilder
getUpdateTransferJobFieldMaskOrBuilder()
The field mask of the fields in `transferJob` that are to be updated in this request.boolean
hasTransferJob()
Required.boolean
hasUpdateTransferJobFieldMask()
The field mask of the fields in `transferJob` that are to be updated in this request.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getJobName
String getJobName()
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
- Returns:
- The jobName.
-
getJobNameBytes
com.google.protobuf.ByteString getJobNameBytes()
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
- Returns:
- The bytes for jobName.
-
getProjectId
String getProjectId()
Required. The ID of the Google Cloud project that owns the job.
string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
- Returns:
- The projectId.
-
getProjectIdBytes
com.google.protobuf.ByteString getProjectIdBytes()
Required. The ID of the Google Cloud project that owns the job.
string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
- Returns:
- The bytes for projectId.
-
hasTransferJob
boolean hasTransferJob()
Required. The job to update. `transferJob` is expected to specify one or more of five fields: [description][google.storagetransfer.v1.TransferJob.description], [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec], [notification_config][google.storagetransfer.v1.TransferJob.notification_config], [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and [status][google.storagetransfer.v1.TransferJob.status]. An `UpdateTransferJobRequest` that specifies other fields are rejected with the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. Updating a job status to [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED] requires `storagetransfer.jobs.delete` permission.
.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
- Returns:
- Whether the transferJob field is set.
-
getTransferJob
TransferTypes.TransferJob getTransferJob()
Required. The job to update. `transferJob` is expected to specify one or more of five fields: [description][google.storagetransfer.v1.TransferJob.description], [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec], [notification_config][google.storagetransfer.v1.TransferJob.notification_config], [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and [status][google.storagetransfer.v1.TransferJob.status]. An `UpdateTransferJobRequest` that specifies other fields are rejected with the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. Updating a job status to [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED] requires `storagetransfer.jobs.delete` permission.
.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
- Returns:
- The transferJob.
-
getTransferJobOrBuilder
TransferTypes.TransferJobOrBuilder getTransferJobOrBuilder()
Required. The job to update. `transferJob` is expected to specify one or more of five fields: [description][google.storagetransfer.v1.TransferJob.description], [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec], [notification_config][google.storagetransfer.v1.TransferJob.notification_config], [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and [status][google.storagetransfer.v1.TransferJob.status]. An `UpdateTransferJobRequest` that specifies other fields are rejected with the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. Updating a job status to [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED] requires `storagetransfer.jobs.delete` permission.
.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
-
hasUpdateTransferJobFieldMask
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][google.storagetransfer.v1.TransferJob.description], [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec], [notification_config][google.storagetransfer.v1.TransferJob.notification_config], [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and [status][google.storagetransfer.v1.TransferJob.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.rpc.Code.INVALID_ARGUMENT].
.google.protobuf.FieldMask update_transfer_job_field_mask = 4;
- Returns:
- Whether the updateTransferJobFieldMask field is set.
-
getUpdateTransferJobFieldMask
com.google.protobuf.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][google.storagetransfer.v1.TransferJob.description], [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec], [notification_config][google.storagetransfer.v1.TransferJob.notification_config], [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and [status][google.storagetransfer.v1.TransferJob.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.rpc.Code.INVALID_ARGUMENT].
.google.protobuf.FieldMask update_transfer_job_field_mask = 4;
- Returns:
- The updateTransferJobFieldMask.
-
getUpdateTransferJobFieldMaskOrBuilder
com.google.protobuf.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][google.storagetransfer.v1.TransferJob.description], [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec], [notification_config][google.storagetransfer.v1.TransferJob.notification_config], [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and [status][google.storagetransfer.v1.TransferJob.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.rpc.Code.INVALID_ARGUMENT].
.google.protobuf.FieldMask update_transfer_job_field_mask = 4;
-
-