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

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

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

  /**
   *    * Immutable. The resource name of the shared set.
   * Shared set resource names have the form:
   *
   * `customers/{customer_id}/sharedSets/{shared_set_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 shared set.
   * Shared set resource names have the form:
   *
   * `customers/{customer_id}/sharedSets/{shared_set_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 this shared set. Read only.
   * 
   *
   * optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. The ID of this shared set. Read only.
   * 
   *
   * optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Immutable. The type of this shared set: each shared set holds only a single
   * kind of resource. Required. Immutable.
   * 
   *
   * .google.ads.googleads.v17.enums.SharedSetTypeEnum.SharedSetType type = 3 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Immutable. The type of this shared set: each shared set holds only a single
   * kind of resource. Required. Immutable.
   * 
   *
   * .google.ads.googleads.v17.enums.SharedSetTypeEnum.SharedSetType type = 3 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The type.
   */
  com.google.ads.googleads.v17.enums.SharedSetTypeEnum.SharedSetType getType();

  /**
   *    * The name of this shared set. Required.
   * Shared Sets must have names that are unique among active shared sets of
   * the same type.
   * The length of this string should be between 1 and 255 UTF-8 bytes,
   * inclusive.
   * 
   *
   * optional string name = 9;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * The name of this shared set. Required.
   * Shared Sets must have names that are unique among active shared sets of
   * the same type.
   * The length of this string should be between 1 and 255 UTF-8 bytes,
   * inclusive.
   * 
   *
   * optional string name = 9;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of this shared set. Required.
   * Shared Sets must have names that are unique among active shared sets of
   * the same type.
   * The length of this string should be between 1 and 255 UTF-8 bytes,
   * inclusive.
   * 
   *
   * optional string name = 9;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Output only. The status of this shared set. Read only.
   * 
   *
   * .google.ads.googleads.v17.enums.SharedSetStatusEnum.SharedSetStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. The status of this shared set. Read only.
   * 
   *
   * .google.ads.googleads.v17.enums.SharedSetStatusEnum.SharedSetStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.SharedSetStatusEnum.SharedSetStatus getStatus();

  /**
   *    * Output only. The number of shared criteria within this shared set. Read
   * only.
   * 
   *
   * optional int64 member_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the memberCount field is set.
   */
  boolean hasMemberCount();
  /**
   *    * Output only. The number of shared criteria within this shared set. Read
   * only.
   * 
   *
   * optional int64 member_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The memberCount.
   */
  long getMemberCount();

  /**
   *    * Output only. The number of campaigns associated with this shared set. Read
   * only.
   * 
   *
   * optional int64 reference_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the referenceCount field is set.
   */
  boolean hasReferenceCount();
  /**
   *    * Output only. The number of campaigns associated with this shared set. Read
   * only.
   * 
   *
   * optional int64 reference_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The referenceCount.
   */
  long getReferenceCount();
}