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

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

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

  /**
   *    * Output only. The resource name of the artifact.
   * Artifact resource names have the form:
   *
   * `googleAdsFields/{name}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Output only. The resource name of the artifact.
   * Artifact resource names have the form:
   *
   * `googleAdsFields/{name}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. The name of the artifact.
   * 
   *
   * optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * Output only. The name of the artifact.
   * 
   *
   * optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Output only. The name of the artifact.
   * 
   *
   * optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Output only. The category of the artifact.
   * 
   *
   * .google.ads.googleads.v17.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for category.
   */
  int getCategoryValue();
  /**
   *    * Output only. The category of the artifact.
   * 
   *
   * .google.ads.googleads.v17.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The category.
   */
  com.google.ads.googleads.v17.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory getCategory();

  /**
   *    * Output only. Whether the artifact can be used in a SELECT clause in search
   * queries.
   * 
   *
   * optional bool selectable = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the selectable field is set.
   */
  boolean hasSelectable();
  /**
   *    * Output only. Whether the artifact can be used in a SELECT clause in search
   * queries.
   * 
   *
   * optional bool selectable = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The selectable.
   */
  boolean getSelectable();

  /**
   *    * Output only. Whether the artifact can be used in a WHERE clause in search
   * queries.
   * 
   *
   * optional bool filterable = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the filterable field is set.
   */
  boolean hasFilterable();
  /**
   *    * Output only. Whether the artifact can be used in a WHERE clause in search
   * queries.
   * 
   *
   * optional bool filterable = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The filterable.
   */
  boolean getFilterable();

  /**
   *    * Output only. Whether the artifact can be used in a ORDER BY clause in
   * search queries.
   * 
   *
   * optional bool sortable = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the sortable field is set.
   */
  boolean hasSortable();
  /**
   *    * Output only. Whether the artifact can be used in a ORDER BY clause in
   * search queries.
   * 
   *
   * optional bool sortable = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The sortable.
   */
  boolean getSortable();

  /**
   *    * Output only. The names of all resources, segments, and metrics that are
   * selectable with the described artifact.
   * 
   *
   * repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the selectableWith.
   */
  java.util.List
      getSelectableWithList();
  /**
   *    * Output only. The names of all resources, segments, and metrics that are
   * selectable with the described artifact.
   * 
   *
   * repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of selectableWith.
   */
  int getSelectableWithCount();
  /**
   *    * Output only. The names of all resources, segments, and metrics that are
   * selectable with the described artifact.
   * 
   *
   * repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the element to return.
   * @return The selectableWith at the given index.
   */
  java.lang.String getSelectableWith(int index);
  /**
   *    * Output only. The names of all resources, segments, and metrics that are
   * selectable with the described artifact.
   * 
   *
   * repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the value to return.
   * @return The bytes of the selectableWith at the given index.
   */
  com.google.protobuf.ByteString
      getSelectableWithBytes(int index);

  /**
   *    * Output only. The names of all resources that are selectable with the
   * described artifact. Fields from these resources do not segment metrics when
   * included in search queries.
   *
   * This field is only set for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the attributeResources.
   */
  java.util.List
      getAttributeResourcesList();
  /**
   *    * Output only. The names of all resources that are selectable with the
   * described artifact. Fields from these resources do not segment metrics when
   * included in search queries.
   *
   * This field is only set for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of attributeResources.
   */
  int getAttributeResourcesCount();
  /**
   *    * Output only. The names of all resources that are selectable with the
   * described artifact. Fields from these resources do not segment metrics when
   * included in search queries.
   *
   * This field is only set for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the element to return.
   * @return The attributeResources at the given index.
   */
  java.lang.String getAttributeResources(int index);
  /**
   *    * Output only. The names of all resources that are selectable with the
   * described artifact. Fields from these resources do not segment metrics when
   * included in search queries.
   *
   * This field is only set for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the value to return.
   * @return The bytes of the attributeResources at the given index.
   */
  com.google.protobuf.ByteString
      getAttributeResourcesBytes(int index);

  /**
   *    * Output only. This field lists the names of all metrics that are selectable
   * with the described artifact when it is used in the FROM clause. It is only
   * set for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the metrics.
   */
  java.util.List
      getMetricsList();
  /**
   *    * Output only. This field lists the names of all metrics that are selectable
   * with the described artifact when it is used in the FROM clause. It is only
   * set for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of metrics.
   */
  int getMetricsCount();
  /**
   *    * Output only. This field lists the names of all metrics that are selectable
   * with the described artifact when it is used in the FROM clause. It is only
   * set for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the element to return.
   * @return The metrics at the given index.
   */
  java.lang.String getMetrics(int index);
  /**
   *    * Output only. This field lists the names of all metrics that are selectable
   * with the described artifact when it is used in the FROM clause. It is only
   * set for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the value to return.
   * @return The bytes of the metrics at the given index.
   */
  com.google.protobuf.ByteString
      getMetricsBytes(int index);

  /**
   *    * Output only. This field lists the names of all artifacts, whether a segment
   * or another resource, that segment metrics when included in search queries
   * and when the described artifact is used in the FROM clause. It is only set
   * for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the segments.
   */
  java.util.List
      getSegmentsList();
  /**
   *    * Output only. This field lists the names of all artifacts, whether a segment
   * or another resource, that segment metrics when included in search queries
   * and when the described artifact is used in the FROM clause. It is only set
   * for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of segments.
   */
  int getSegmentsCount();
  /**
   *    * Output only. This field lists the names of all artifacts, whether a segment
   * or another resource, that segment metrics when included in search queries
   * and when the described artifact is used in the FROM clause. It is only set
   * for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the element to return.
   * @return The segments at the given index.
   */
  java.lang.String getSegments(int index);
  /**
   *    * Output only. This field lists the names of all artifacts, whether a segment
   * or another resource, that segment metrics when included in search queries
   * and when the described artifact is used in the FROM clause. It is only set
   * for artifacts whose category is RESOURCE.
   * 
   *
   * repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the value to return.
   * @return The bytes of the segments at the given index.
   */
  com.google.protobuf.ByteString
      getSegmentsBytes(int index);

  /**
   *    * Output only. Values the artifact can assume if it is a field of type ENUM.
   *
   * This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
   * 
   *
   * repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the enumValues.
   */
  java.util.List
      getEnumValuesList();
  /**
   *    * Output only. Values the artifact can assume if it is a field of type ENUM.
   *
   * This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
   * 
   *
   * repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of enumValues.
   */
  int getEnumValuesCount();
  /**
   *    * Output only. Values the artifact can assume if it is a field of type ENUM.
   *
   * This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
   * 
   *
   * repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the element to return.
   * @return The enumValues at the given index.
   */
  java.lang.String getEnumValues(int index);
  /**
   *    * Output only. Values the artifact can assume if it is a field of type ENUM.
   *
   * This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
   * 
   *
   * repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the value to return.
   * @return The bytes of the enumValues at the given index.
   */
  com.google.protobuf.ByteString
      getEnumValuesBytes(int index);

  /**
   *    * Output only. This field determines the operators that can be used with the
   * artifact in WHERE clauses.
   * 
   *
   * .google.ads.googleads.v17.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for dataType.
   */
  int getDataTypeValue();
  /**
   *    * Output only. This field determines the operators that can be used with the
   * artifact in WHERE clauses.
   * 
   *
   * .google.ads.googleads.v17.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The dataType.
   */
  com.google.ads.googleads.v17.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType getDataType();

  /**
   *    * Output only. The URL of proto describing the artifact's data type.
   * 
   *
   * optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the typeUrl field is set.
   */
  boolean hasTypeUrl();
  /**
   *    * Output only. The URL of proto describing the artifact's data type.
   * 
   *
   * optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The typeUrl.
   */
  java.lang.String getTypeUrl();
  /**
   *    * Output only. The URL of proto describing the artifact's data type.
   * 
   *
   * optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for typeUrl.
   */
  com.google.protobuf.ByteString
      getTypeUrlBytes();

  /**
   *    * Output only. Whether the field artifact is repeated.
   * 
   *
   * optional bool is_repeated = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the isRepeated field is set.
   */
  boolean hasIsRepeated();
  /**
   *    * Output only. Whether the field artifact is repeated.
   * 
   *
   * optional bool is_repeated = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The isRepeated.
   */
  boolean getIsRepeated();
}