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

Class BatchJob

  • All Implemented Interfaces:
    BatchJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class BatchJob
extends com.google.protobuf.GeneratedMessageV3
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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BatchJob.BatchJobMetadata
      Additional information about the batch job.
      static interface  BatchJob.BatchJobMetadataOrBuilder  
      static class  BatchJob.Builder
      A list of mutates being processed asynchronously.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEXT_ADD_SEQUENCE_TOKEN_FIELD_NUMBER

        public static final int NEXT_ADD_SEQUENCE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LONG_RUNNING_OPERATION_FIELD_NUMBER

        public static final int LONG_RUNNING_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static BatchJob parseFrom​(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchJob parseFrom​(java.nio.ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchJob parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchJob parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchJob parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchJob parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchJob parseFrom​(java.io.InputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static BatchJob parseFrom​(java.io.InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static BatchJob parseDelimitedFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static BatchJob parseDelimitedFrom​(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static BatchJob parseFrom​(com.google.protobuf.CodedInputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static BatchJob parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected BatchJob.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static BatchJob getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<BatchJob> parser()

      • getParserForType

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

      • getDefaultInstanceForType

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