Package com.google.ads.googleads.v10.resources

Class BatchJob.Builder

  • All Implemented Interfaces:
    BatchJobOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    BatchJob
    public static final class BatchJob.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>
implements BatchJobOrBuilder
     A list of mutates being processed asynchronously. The mutates are uploaded
 by the user. The mutates themselves aren't readable and the results of the
 job can only be read using BatchJobService.ListBatchJobResults.
    Protobuf type google.ads.googleads.v10.resources.BatchJob

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • clear

        public BatchJob.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • getDefaultInstanceForType

        public BatchJob getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public BatchJob build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public BatchJob buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public BatchJob.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • setField

        public BatchJob.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • clearField

        public BatchJob.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • clearOneof

        public BatchJob.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • setRepeatedField

        public BatchJob.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • addRepeatedField

        public BatchJob.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • mergeFrom

        public BatchJob.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchJob.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • mergeFrom

        public BatchJob.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchJob.Builder>
        Throws:
        java.io.IOException

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the batch job.
 Batch job resource names have the form:
 `customers/{customer_id}/batchJobs/{batch_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface BatchJobOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the batch job.
 Batch job resource names have the form:
 `customers/{customer_id}/batchJobs/{batch_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface BatchJobOrBuilder
        Returns:
        The bytes for resourceName.

      • setResourceName

        public BatchJob.Builder setResourceName​(java.lang.String value)
         Immutable. The resource name of the batch job.
 Batch job resource names have the form:
 `customers/{customer_id}/batchJobs/{batch_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The resourceName to set.
        Returns:
        This builder for chaining.

      • clearResourceName

        public BatchJob.Builder clearResourceName()
         Immutable. The resource name of the batch job.
 Batch job resource names have the form:
 `customers/{customer_id}/batchJobs/{batch_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setResourceNameBytes

        public BatchJob.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         Immutable. The resource name of the batch job.
 Batch job resource names have the form:
 `customers/{customer_id}/batchJobs/{batch_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for resourceName to set.
        Returns:
        This builder for chaining.

      • hasId

        public boolean hasId()
         Output only. ID of this batch job.
        optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface BatchJobOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         Output only. ID of this batch job.
        optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface BatchJobOrBuilder
        Returns:
        The id.

      • setId

        public BatchJob.Builder setId​(long value)
         Output only. ID of this batch job.
        optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public BatchJob.Builder clearId()
         Output only. ID of this batch job.
        optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • hasNextAddSequenceToken

        public boolean hasNextAddSequenceToken()
         Output only. The next sequence token to use when adding operations. Only set when the
 batch job status is PENDING.
        optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasNextAddSequenceToken in interface BatchJobOrBuilder
        Returns:
        Whether the nextAddSequenceToken field is set.

      • getNextAddSequenceToken

        public java.lang.String getNextAddSequenceToken()
         Output only. The next sequence token to use when adding operations. Only set when the
 batch job status is PENDING.
        optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNextAddSequenceToken in interface BatchJobOrBuilder
        Returns:
        The nextAddSequenceToken.

      • getNextAddSequenceTokenBytes

        public com.google.protobuf.ByteString getNextAddSequenceTokenBytes()
         Output only. The next sequence token to use when adding operations. Only set when the
 batch job status is PENDING.
        optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNextAddSequenceTokenBytes in interface BatchJobOrBuilder
        Returns:
        The bytes for nextAddSequenceToken.

      • setNextAddSequenceToken

        public BatchJob.Builder setNextAddSequenceToken​(java.lang.String value)
         Output only. The next sequence token to use when adding operations. Only set when the
 batch job status is PENDING.
        optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The nextAddSequenceToken to set.
        Returns:
        This builder for chaining.

      • clearNextAddSequenceToken

        public BatchJob.Builder clearNextAddSequenceToken()
         Output only. The next sequence token to use when adding operations. Only set when the
 batch job status is PENDING.
        optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setNextAddSequenceTokenBytes

        public BatchJob.Builder setNextAddSequenceTokenBytes​(com.google.protobuf.ByteString value)
         Output only. The next sequence token to use when adding operations. Only set when the
 batch job status is PENDING.
        optional string next_add_sequence_token = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for nextAddSequenceToken to set.
        Returns:
        This builder for chaining.

      • hasMetadata

        public boolean hasMetadata()
         Output only. Contains additional information about this batch job.
        .google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasMetadata in interface BatchJobOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public BatchJob.BatchJobMetadata getMetadata()
         Output only. Contains additional information about this batch job.
        .google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetadata in interface BatchJobOrBuilder
        Returns:
        The metadata.

      • setMetadata

        public BatchJob.Builder setMetadata​(BatchJob.BatchJobMetadata value)
         Output only. Contains additional information about this batch job.
        .google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setMetadata

        public BatchJob.Builder setMetadata​(BatchJob.BatchJobMetadata.Builder builderForValue)
         Output only. Contains additional information about this batch job.
        .google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeMetadata

        public BatchJob.Builder mergeMetadata​(BatchJob.BatchJobMetadata value)
         Output only. Contains additional information about this batch job.
        .google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearMetadata

        public BatchJob.Builder clearMetadata()
         Output only. Contains additional information about this batch job.
        .google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMetadataBuilder

        public BatchJob.BatchJobMetadata.Builder getMetadataBuilder()
         Output only. Contains additional information about this batch job.
        .google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStatusValue

        public int getStatusValue()
         Output only. Status of this batch job.
        .google.ads.googleads.v10.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface BatchJobOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • setStatusValue

        public BatchJob.Builder setStatusValue​(int value)
         Output only. Status of this batch job.
        .google.ads.googleads.v10.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for status to set.
        Returns:
        This builder for chaining.

      • getStatus

        public BatchJobStatusEnum.BatchJobStatus getStatus()
         Output only. Status of this batch job.
        .google.ads.googleads.v10.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatus in interface BatchJobOrBuilder
        Returns:
        The status.

      • setStatus

        public BatchJob.Builder setStatus​(BatchJobStatusEnum.BatchJobStatus value)
         Output only. Status of this batch job.
        .google.ads.googleads.v10.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The status to set.
        Returns:
        This builder for chaining.

      • clearStatus

        public BatchJob.Builder clearStatus()
         Output only. Status of this batch job.
        .google.ads.googleads.v10.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • hasLongRunningOperation

        public boolean hasLongRunningOperation()
         Output only. The resource name of the long-running operation that can be used to poll
 for completion. Only set when the batch job status is RUNNING or DONE.
        optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasLongRunningOperation in interface BatchJobOrBuilder
        Returns:
        Whether the longRunningOperation field is set.

      • getLongRunningOperation

        public java.lang.String getLongRunningOperation()
         Output only. The resource name of the long-running operation that can be used to poll
 for completion. Only set when the batch job status is RUNNING or DONE.
        optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLongRunningOperation in interface BatchJobOrBuilder
        Returns:
        The longRunningOperation.

      • getLongRunningOperationBytes

        public com.google.protobuf.ByteString getLongRunningOperationBytes()
         Output only. The resource name of the long-running operation that can be used to poll
 for completion. Only set when the batch job status is RUNNING or DONE.
        optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLongRunningOperationBytes in interface BatchJobOrBuilder
        Returns:
        The bytes for longRunningOperation.

      • setLongRunningOperation

        public BatchJob.Builder setLongRunningOperation​(java.lang.String value)
         Output only. The resource name of the long-running operation that can be used to poll
 for completion. Only set when the batch job status is RUNNING or DONE.
        optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The longRunningOperation to set.
        Returns:
        This builder for chaining.

      • clearLongRunningOperation

        public BatchJob.Builder clearLongRunningOperation()
         Output only. The resource name of the long-running operation that can be used to poll
 for completion. Only set when the batch job status is RUNNING or DONE.
        optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setLongRunningOperationBytes

        public BatchJob.Builder setLongRunningOperationBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the long-running operation that can be used to poll
 for completion. Only set when the batch job status is RUNNING or DONE.
        optional string long_running_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for longRunningOperation to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final BatchJob.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>

      • mergeUnknownFields

        public final BatchJob.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.Builder>