Package com.google.ads.googleads.v18.resources

Class BatchJob.BatchJobMetadata.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.BatchJobMetadata.Builder>
com.google.ads.googleads.v18.resources.BatchJob.BatchJobMetadata.Builder
All Implemented Interfaces:
BatchJob.BatchJobMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
BatchJob.BatchJobMetadata
public static final class BatchJob.BatchJobMetadata.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<BatchJob.BatchJobMetadata.Builder> implements BatchJob.BatchJobMetadataOrBuilder
 Additional information about the batch job. This message is also used as
 metadata returned in batch job Long Running Operations.
Protobuf type google.ads.googleads.v18.resources.BatchJob.BatchJobMetadata

  • Method Details

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

    • clear

      public BatchJob.BatchJobMetadata.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.BatchJobMetadata.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.BatchJobMetadata.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public BatchJob.BatchJobMetadata.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.BatchJobMetadata.Builder>

    • setField

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

    • clearField

      public BatchJob.BatchJobMetadata.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.BatchJobMetadata.Builder>

    • clearOneof

      public BatchJob.BatchJobMetadata.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.BatchJobMetadata.Builder>

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

      public BatchJob.BatchJobMetadata.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.BatchJobMetadata.Builder>

    • mergeFrom

      public BatchJob.BatchJobMetadata.Builder mergeFrom(BatchJob.BatchJobMetadata other)

    • isInitialized

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

    • mergeFrom

      public BatchJob.BatchJobMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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.BatchJobMetadata.Builder>
      Throws:
      IOException

    • hasCreationDateTime

      public boolean hasCreationDateTime()
       Output only. The time when this batch job was created.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
      optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreationDateTime in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      Whether the creationDateTime field is set.

    • getCreationDateTime

      public String getCreationDateTime()
       Output only. The time when this batch job was created.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
      optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreationDateTime in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The creationDateTime.

    • getCreationDateTimeBytes

      public com.google.protobuf.ByteString getCreationDateTimeBytes()
       Output only. The time when this batch job was created.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
      optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreationDateTimeBytes in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The bytes for creationDateTime.

    • setCreationDateTime

      public BatchJob.BatchJobMetadata.Builder setCreationDateTime(String value)
       Output only. The time when this batch job was created.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
      optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The creationDateTime to set.
      Returns:
      This builder for chaining.

    • clearCreationDateTime

      public BatchJob.BatchJobMetadata.Builder clearCreationDateTime()
       Output only. The time when this batch job was created.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
      optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setCreationDateTimeBytes

      public BatchJob.BatchJobMetadata.Builder setCreationDateTimeBytes(com.google.protobuf.ByteString value)
       Output only. The time when this batch job was created.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
      optional string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for creationDateTime to set.
      Returns:
      This builder for chaining.

    • hasStartDateTime

      public boolean hasStartDateTime()
       Output only. The time when this batch job started running.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
      optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasStartDateTime in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      Whether the startDateTime field is set.

    • getStartDateTime

      public String getStartDateTime()
       Output only. The time when this batch job started running.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
      optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartDateTime in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The startDateTime.

    • getStartDateTimeBytes

      public com.google.protobuf.ByteString getStartDateTimeBytes()
       Output only. The time when this batch job started running.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
      optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartDateTimeBytes in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The bytes for startDateTime.

    • setStartDateTime

      public BatchJob.BatchJobMetadata.Builder setStartDateTime(String value)
       Output only. The time when this batch job started running.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
      optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The startDateTime to set.
      Returns:
      This builder for chaining.

    • clearStartDateTime

      public BatchJob.BatchJobMetadata.Builder clearStartDateTime()
       Output only. The time when this batch job started running.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
      optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setStartDateTimeBytes

      public BatchJob.BatchJobMetadata.Builder setStartDateTimeBytes(com.google.protobuf.ByteString value)
       Output only. The time when this batch job started running.
 Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
      optional string start_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for startDateTime to set.
      Returns:
      This builder for chaining.

    • hasCompletionDateTime

      public boolean hasCompletionDateTime()
       Output only. The time when this batch job was completed.
 Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
      optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCompletionDateTime in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      Whether the completionDateTime field is set.

    • getCompletionDateTime

      public String getCompletionDateTime()
       Output only. The time when this batch job was completed.
 Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
      optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCompletionDateTime in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The completionDateTime.

    • getCompletionDateTimeBytes

      public com.google.protobuf.ByteString getCompletionDateTimeBytes()
       Output only. The time when this batch job was completed.
 Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
      optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCompletionDateTimeBytes in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The bytes for completionDateTime.

    • setCompletionDateTime

      public BatchJob.BatchJobMetadata.Builder setCompletionDateTime(String value)
       Output only. The time when this batch job was completed.
 Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
      optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The completionDateTime to set.
      Returns:
      This builder for chaining.

    • clearCompletionDateTime

      public BatchJob.BatchJobMetadata.Builder clearCompletionDateTime()
       Output only. The time when this batch job was completed.
 Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
      optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setCompletionDateTimeBytes

      public BatchJob.BatchJobMetadata.Builder setCompletionDateTimeBytes(com.google.protobuf.ByteString value)
       Output only. The time when this batch job was completed.
 Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
      optional string completion_date_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for completionDateTime to set.
      Returns:
      This builder for chaining.

    • hasEstimatedCompletionRatio

      public boolean hasEstimatedCompletionRatio()
       Output only. The fraction (between 0.0 and 1.0) of mutates that have been
 processed. This is empty if the job hasn't started running yet.
      optional double estimated_completion_ratio = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEstimatedCompletionRatio in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      Whether the estimatedCompletionRatio field is set.

    • getEstimatedCompletionRatio

      public double getEstimatedCompletionRatio()
       Output only. The fraction (between 0.0 and 1.0) of mutates that have been
 processed. This is empty if the job hasn't started running yet.
      optional double estimated_completion_ratio = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEstimatedCompletionRatio in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The estimatedCompletionRatio.

    • setEstimatedCompletionRatio

      public BatchJob.BatchJobMetadata.Builder setEstimatedCompletionRatio(double value)
       Output only. The fraction (between 0.0 and 1.0) of mutates that have been
 processed. This is empty if the job hasn't started running yet.
      optional double estimated_completion_ratio = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The estimatedCompletionRatio to set.
      Returns:
      This builder for chaining.

    • clearEstimatedCompletionRatio

      public BatchJob.BatchJobMetadata.Builder clearEstimatedCompletionRatio()
       Output only. The fraction (between 0.0 and 1.0) of mutates that have been
 processed. This is empty if the job hasn't started running yet.
      optional double estimated_completion_ratio = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasOperationCount

      public boolean hasOperationCount()
       Output only. The number of mutate operations in the batch job.
      optional int64 operation_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasOperationCount in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      Whether the operationCount field is set.

    • getOperationCount

      public long getOperationCount()
       Output only. The number of mutate operations in the batch job.
      optional int64 operation_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOperationCount in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The operationCount.

    • setOperationCount

      public BatchJob.BatchJobMetadata.Builder setOperationCount(long value)
       Output only. The number of mutate operations in the batch job.
      optional int64 operation_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The operationCount to set.
      Returns:
      This builder for chaining.

    • clearOperationCount

      public BatchJob.BatchJobMetadata.Builder clearOperationCount()
       Output only. The number of mutate operations in the batch job.
      optional int64 operation_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasExecutedOperationCount

      public boolean hasExecutedOperationCount()
       Output only. The number of mutate operations executed by the batch job.
 Present only if the job has started running.
      optional int64 executed_operation_count = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasExecutedOperationCount in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      Whether the executedOperationCount field is set.

    • getExecutedOperationCount

      public long getExecutedOperationCount()
       Output only. The number of mutate operations executed by the batch job.
 Present only if the job has started running.
      optional int64 executed_operation_count = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExecutedOperationCount in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The executedOperationCount.

    • setExecutedOperationCount

      public BatchJob.BatchJobMetadata.Builder setExecutedOperationCount(long value)
       Output only. The number of mutate operations executed by the batch job.
 Present only if the job has started running.
      optional int64 executed_operation_count = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The executedOperationCount to set.
      Returns:
      This builder for chaining.

    • clearExecutedOperationCount

      public BatchJob.BatchJobMetadata.Builder clearExecutedOperationCount()
       Output only. The number of mutate operations executed by the batch job.
 Present only if the job has started running.
      optional int64 executed_operation_count = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasExecutionLimitSeconds

      public boolean hasExecutionLimitSeconds()
       Immutable. The approximate upper bound for how long a batch job can be
 executed, in seconds. If the job runs more than the given upper bound,
 the job will be canceled.
      optional int32 execution_limit_seconds = 13 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasExecutionLimitSeconds in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      Whether the executionLimitSeconds field is set.

    • getExecutionLimitSeconds

      public int getExecutionLimitSeconds()
       Immutable. The approximate upper bound for how long a batch job can be
 executed, in seconds. If the job runs more than the given upper bound,
 the job will be canceled.
      optional int32 execution_limit_seconds = 13 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getExecutionLimitSeconds in interface BatchJob.BatchJobMetadataOrBuilder
      Returns:
      The executionLimitSeconds.

    • setExecutionLimitSeconds

      public BatchJob.BatchJobMetadata.Builder setExecutionLimitSeconds(int value)
       Immutable. The approximate upper bound for how long a batch job can be
 executed, in seconds. If the job runs more than the given upper bound,
 the job will be canceled.
      optional int32 execution_limit_seconds = 13 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The executionLimitSeconds to set.
      Returns:
      This builder for chaining.

    • clearExecutionLimitSeconds

      public BatchJob.BatchJobMetadata.Builder clearExecutionLimitSeconds()
       Immutable. The approximate upper bound for how long a batch job can be
 executed, in seconds. If the job runs more than the given upper bound,
 the job will be canceled.
      optional int32 execution_limit_seconds = 13 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final BatchJob.BatchJobMetadata.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.BatchJobMetadata.Builder>

    • mergeUnknownFields

      public final BatchJob.BatchJobMetadata.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.BatchJobMetadata.Builder>