public static final class TransferProto.UpdateTransferJobRequest.Builder extends GeneratedMessageV3.Builder<TransferProto.UpdateTransferJobRequest.Builder> implements TransferProto.UpdateTransferJobRequestOrBuilder
Request passed to UpdateTransferJob.
Protobuf type google.storagetransfer.v1.UpdateTransferJobRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferProto.UpdateTransferJobRequest.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferProto.UpdateTransferJobRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
build()
public TransferProto.UpdateTransferJobRequest build()
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest |
buildPartial()
public TransferProto.UpdateTransferJobRequest buildPartial()
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest |
clear()
public TransferProto.UpdateTransferJobRequest.Builder clear()
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public TransferProto.UpdateTransferJobRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
clearJobName()
public TransferProto.UpdateTransferJobRequest.Builder clearJobName()
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferProto.UpdateTransferJobRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
clearProjectId()
public TransferProto.UpdateTransferJobRequest.Builder clearProjectId()
Required. The ID of the Google Cloud project that owns the job.
string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
This builder for chaining. |
clearTransferJob()
public TransferProto.UpdateTransferJobRequest.Builder clearTransferJob()
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 | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
clearUpdateTransferJobFieldMask()
public TransferProto.UpdateTransferJobRequest.Builder clearUpdateTransferJobFieldMask()
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 | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
clone()
public TransferProto.UpdateTransferJobRequest.Builder clone()
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
getDefaultInstanceForType()
public TransferProto.UpdateTransferJobRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getJobName()
public String getJobName()
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The jobName. |
getJobNameBytes()
public ByteString getJobNameBytes()
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for jobName. |
getProjectId()
public String getProjectId()
Required. The ID of the Google Cloud project that owns the job.
string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The projectId. |
getProjectIdBytes()
public ByteString getProjectIdBytes()
Required. The ID of the Google Cloud project that owns the job.
string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for projectId. |
getTransferJob()
public 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 | |
---|---|
Type | Description |
TransferTypes.TransferJob |
The transferJob. |
getTransferJobBuilder()
public TransferTypes.TransferJob.Builder getTransferJobBuilder()
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 | |
---|---|
Type | Description |
TransferTypes.TransferJob.Builder |
getTransferJobOrBuilder()
public 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 | |
---|---|
Type | Description |
TransferTypes.TransferJobOrBuilder |
getUpdateTransferJobFieldMask()
public 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 | |
---|---|
Type | Description |
FieldMask |
The updateTransferJobFieldMask. |
getUpdateTransferJobFieldMaskBuilder()
public FieldMask.Builder getUpdateTransferJobFieldMaskBuilder()
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 | |
---|---|
Type | Description |
Builder |
getUpdateTransferJobFieldMaskOrBuilder()
public 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 | |
---|---|
Type | Description |
FieldMaskOrBuilder |
hasTransferJob()
public 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 | |
---|---|
Type | Description |
boolean |
Whether the transferJob field is set. |
hasUpdateTransferJobFieldMask()
public 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 | |
---|---|
Type | Description |
boolean |
Whether the updateTransferJobFieldMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransferProto.UpdateTransferJobRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public TransferProto.UpdateTransferJobRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
mergeFrom(TransferProto.UpdateTransferJobRequest other)
public TransferProto.UpdateTransferJobRequest.Builder mergeFrom(TransferProto.UpdateTransferJobRequest other)
Parameter | |
---|---|
Name | Description |
other |
TransferProto.UpdateTransferJobRequest |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
mergeTransferJob(TransferTypes.TransferJob value)
public TransferProto.UpdateTransferJobRequest.Builder mergeTransferJob(TransferTypes.TransferJob value)
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];
Parameter | |
---|---|
Name | Description |
value |
TransferTypes.TransferJob |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransferProto.UpdateTransferJobRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
mergeUpdateTransferJobFieldMask(FieldMask value)
public TransferProto.UpdateTransferJobRequest.Builder mergeUpdateTransferJobFieldMask(FieldMask value)
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;
Parameter | |
---|---|
Name | Description |
value |
FieldMask |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public TransferProto.UpdateTransferJobRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
setJobName(String value)
public TransferProto.UpdateTransferJobRequest.Builder setJobName(String value)
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The jobName to set. |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
This builder for chaining. |
setJobNameBytes(ByteString value)
public TransferProto.UpdateTransferJobRequest.Builder setJobNameBytes(ByteString value)
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for jobName to set. |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
This builder for chaining. |
setProjectId(String value)
public TransferProto.UpdateTransferJobRequest.Builder setProjectId(String value)
Required. The ID of the Google Cloud project that owns the job.
string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The projectId to set. |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
This builder for chaining. |
setProjectIdBytes(ByteString value)
public TransferProto.UpdateTransferJobRequest.Builder setProjectIdBytes(ByteString value)
Required. The ID of the Google Cloud project that owns the job.
string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for projectId to set. |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TransferProto.UpdateTransferJobRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
setTransferJob(TransferTypes.TransferJob value)
public TransferProto.UpdateTransferJobRequest.Builder setTransferJob(TransferTypes.TransferJob value)
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];
Parameter | |
---|---|
Name | Description |
value |
TransferTypes.TransferJob |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
setTransferJob(TransferTypes.TransferJob.Builder builderForValue)
public TransferProto.UpdateTransferJobRequest.Builder setTransferJob(TransferTypes.TransferJob.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
TransferTypes.TransferJob.Builder |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final TransferProto.UpdateTransferJobRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
setUpdateTransferJobFieldMask(FieldMask value)
public TransferProto.UpdateTransferJobRequest.Builder setUpdateTransferJobFieldMask(FieldMask value)
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;
Parameter | |
---|---|
Name | Description |
value |
FieldMask |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |
setUpdateTransferJobFieldMask(FieldMask.Builder builderForValue)
public TransferProto.UpdateTransferJobRequest.Builder setUpdateTransferJobFieldMask(FieldMask.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
TransferProto.UpdateTransferJobRequest.Builder |