com.google.ads.googleads.v17.resources.CampaignDraftOrBuilder 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/campaign_draft.proto

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

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

  /**
   *    * Immutable. The resource name of the campaign draft.
   * Campaign draft resource names have the form:
   *
   * `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_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 campaign draft.
   * Campaign draft resource names have the form:
   *
   * `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_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. The ID of the draft.
   *
   * This field is read-only.
   * 
   *
   * optional int64 draft_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the draftId field is set.
   */
  boolean hasDraftId();
  /**
   *    * Output only. The ID of the draft.
   *
   * This field is read-only.
   * 
   *
   * optional int64 draft_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The draftId.
   */
  long getDraftId();

  /**
   *    * Immutable. The base campaign to which the draft belongs.
   * 
   *
   * optional string base_campaign = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return Whether the baseCampaign field is set.
   */
  boolean hasBaseCampaign();
  /**
   *    * Immutable. The base campaign to which the draft belongs.
   * 
   *
   * optional string base_campaign = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The baseCampaign.
   */
  java.lang.String getBaseCampaign();
  /**
   *    * Immutable. The base campaign to which the draft belongs.
   * 
   *
   * optional string base_campaign = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for baseCampaign.
   */
  com.google.protobuf.ByteString
      getBaseCampaignBytes();

  /**
   *    * The name of the campaign draft.
   *
   * This field is required and should not be empty when creating new
   * campaign drafts.
   *
   * It must not contain any null (code point 0x0), NL line feed
   * (code point 0xA) or carriage return (code point 0xD) characters.
   * 
   *
   * optional string name = 11;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * The name of the campaign draft.
   *
   * This field is required and should not be empty when creating new
   * campaign drafts.
   *
   * It must not contain any null (code point 0x0), NL line feed
   * (code point 0xA) or carriage return (code point 0xD) characters.
   * 
   *
   * optional string name = 11;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of the campaign draft.
   *
   * This field is required and should not be empty when creating new
   * campaign drafts.
   *
   * It must not contain any null (code point 0x0), NL line feed
   * (code point 0xA) or carriage return (code point 0xD) characters.
   * 
   *
   * optional string name = 11;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Output only. Resource name of the Campaign that results from overlaying the
   * draft changes onto the base campaign.
   *
   * This field is read-only.
   * 
   *
   * optional string draft_campaign = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return Whether the draftCampaign field is set.
   */
  boolean hasDraftCampaign();
  /**
   *    * Output only. Resource name of the Campaign that results from overlaying the
   * draft changes onto the base campaign.
   *
   * This field is read-only.
   * 
   *
   * optional string draft_campaign = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The draftCampaign.
   */
  java.lang.String getDraftCampaign();
  /**
   *    * Output only. Resource name of the Campaign that results from overlaying the
   * draft changes onto the base campaign.
   *
   * This field is read-only.
   * 
   *
   * optional string draft_campaign = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The bytes for draftCampaign.
   */
  com.google.protobuf.ByteString
      getDraftCampaignBytes();

  /**
   *    * Output only. The status of the campaign draft. This field is read-only.
   *
   * When a new campaign draft is added, the status defaults to PROPOSED.
   * 
   *
   * .google.ads.googleads.v17.enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. The status of the campaign draft. This field is read-only.
   *
   * When a new campaign draft is added, the status defaults to PROPOSED.
   * 
   *
   * .google.ads.googleads.v17.enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.CampaignDraftStatusEnum.CampaignDraftStatus getStatus();

  /**
   *    * Output only. Whether there is an experiment based on this draft currently
   * serving.
   * 
   *
   * optional bool has_experiment_running = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the hasExperimentRunning field is set.
   */
  boolean hasHasExperimentRunning();
  /**
   *    * Output only. Whether there is an experiment based on this draft currently
   * serving.
   * 
   *
   * optional bool has_experiment_running = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The hasExperimentRunning.
   */
  boolean getHasExperimentRunning();

  /**
   *    * Output only. The resource name of the long-running operation that can be
   * used to poll for completion of draft promotion. This is only set if the
   * draft promotion is in progress or finished.
   * 
   *
   * optional string long_running_operation = 14 [(.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 of draft promotion. This is only set if the
   * draft promotion is in progress or finished.
   * 
   *
   * optional string long_running_operation = 14 [(.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 of draft promotion. This is only set if the
   * draft promotion is in progress or finished.
   * 
   *
   * optional string long_running_operation = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for longRunningOperation.
   */
  com.google.protobuf.ByteString
      getLongRunningOperationBytes();
}