com.google.ads.googleads.v17.resources.BatchJobOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/batch_job.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface BatchJobOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.BatchJob)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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) = { ... }
   * @return The resourceName.
   */
  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) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. ID of this batch job.
   * 
   *
   * optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. ID of this batch job.
   * 
   *
   * optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * 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];
   * @return Whether the nextAddSequenceToken field is set.
   */
  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];
   * @return The nextAddSequenceToken.
   */
  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];
   * @return The bytes for nextAddSequenceToken.
   */
  com.google.protobuf.ByteString
      getNextAddSequenceTokenBytes();

  /**
   *    * Output only. Contains additional information about this batch job.
   * 
   *
   * .google.ads.googleads.v17.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the metadata field is set.
   */
  boolean hasMetadata();
  /**
   *    * Output only. Contains additional information about this batch job.
   * 
   *
   * .google.ads.googleads.v17.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The metadata.
   */
  com.google.ads.googleads.v17.resources.BatchJob.BatchJobMetadata getMetadata();
  /**
   *    * Output only. Contains additional information about this batch job.
   * 
   *
   * .google.ads.googleads.v17.resources.BatchJob.BatchJobMetadata metadata = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.BatchJob.BatchJobMetadataOrBuilder getMetadataOrBuilder();

  /**
   *    * Output only. Status of this batch job.
   * 
   *
   * .google.ads.googleads.v17.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. Status of this batch job.
   * 
   *
   * .google.ads.googleads.v17.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.BatchJobStatusEnum.BatchJobStatus getStatus();

  /**
   *    * 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];
   * @return Whether the longRunningOperation field is set.
   */
  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];
   * @return The longRunningOperation.
   */
  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];
   * @return The bytes for longRunningOperation.
   */
  com.google.protobuf.ByteString
      getLongRunningOperationBytes();
}