com.google.ads.googleads.v10.resources.AudienceOrBuilder Maven / Gradle / Ivy

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

package com.google.ads.googleads.v10.resources;

public interface AudienceOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v10.resources.Audience)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Immutable. The resource name of the audience.
   * Audience names have the form:
   * `customers/{customer_id}/audiences/{audience_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 audience.
   * Audience names have the form:
   * `customers/{customer_id}/audiences/{audience_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 the audience.
   * 
   *
   * int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Output only. Status of this audience. Indicates whether the audience
   * is enabled or removed.
   * 
   *
   * .google.ads.googleads.v10.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. Status of this audience. Indicates whether the audience
   * is enabled or removed.
   * 
   *
   * .google.ads.googleads.v10.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v10.enums.AudienceStatusEnum.AudienceStatus getStatus();

  /**
   *    * Required. Name of the audience. It should be unique across all
   * audiences. It must have a minimum length of 1 and
   * maximum length of 255.
   * 
   *
   * string name = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Required. Name of the audience. It should be unique across all
   * audiences. It must have a minimum length of 1 and
   * maximum length of 255.
   * 
   *
   * string name = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Description of this audience.
   * 
   *
   * string description = 5;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * Description of this audience.
   * 
   *
   * string description = 5;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;
   */
  java.util.List 
      getDimensionsList();
  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;
   */
  com.google.ads.googleads.v10.common.AudienceDimension getDimensions(int index);
  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;
   */
  int getDimensionsCount();
  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;
   */
  java.util.List 
      getDimensionsOrBuilderList();
  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;
   */
  com.google.ads.googleads.v10.common.AudienceDimensionOrBuilder getDimensionsOrBuilder(
      int index);

  /**
   *    * Negative dimension specifying the audience composition.
   * 
   *
   * .google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;
   * @return Whether the exclusionDimension field is set.
   */
  boolean hasExclusionDimension();
  /**
   *    * Negative dimension specifying the audience composition.
   * 
   *
   * .google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;
   * @return The exclusionDimension.
   */
  com.google.ads.googleads.v10.common.AudienceExclusionDimension getExclusionDimension();
  /**
   *    * Negative dimension specifying the audience composition.
   * 
   *
   * .google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;
   */
  com.google.ads.googleads.v10.common.AudienceExclusionDimensionOrBuilder getExclusionDimensionOrBuilder();
}