/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/analytics/admin/v1alpha/audience.proto

package com.google.analytics.admin.v1alpha;

public interface AudienceOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.analytics.admin.v1alpha.Audience)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * Output only. The resource name for this Audience resource.
   * Format: properties/{propertyId}/audiences/{audienceId}
   * </pre>
   *
   * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   * <pre>
   * Output only. The resource name for this Audience resource.
   * Format: properties/{propertyId}/audiences/{audienceId}
   * </pre>
   *
   * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   * <pre>
   * Required. The display name of the Audience.
   * </pre>
   *
   * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code>
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   * <pre>
   * Required. The display name of the Audience.
   * </pre>
   *
   * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code>
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   * <pre>
   * Required. The description of the Audience.
   * </pre>
   *
   * <code>string description = 3 [(.google.api.field_behavior) = REQUIRED];</code>
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   * <pre>
   * Required. The description of the Audience.
   * </pre>
   *
   * <code>string description = 3 [(.google.api.field_behavior) = REQUIRED];</code>
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   * <pre>
   * Required. Immutable. The duration a user should stay in an Audience. It
   * cannot be set to more than 540 days.
   * </pre>
   *
   * <code>
   * int32 membership_duration_days = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * </code>
   *
   * @return The membershipDurationDays.
   */
  int getMembershipDurationDays();

  /**
   *
   *
   * <pre>
   * Output only. It is automatically set by GA to false if this is an NPA
   * Audience and is excluded from ads personalization.
   * </pre>
   *
   * <code>bool ads_personalization_enabled = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The adsPersonalizationEnabled.
   */
  boolean getAdsPersonalizationEnabled();

  /**
   *
   *
   * <pre>
   * Optional. Specifies an event to log when a user joins the Audience. If not
   * set, no event is logged when a user joins the Audience.
   * </pre>
   *
   * <code>
   * .google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];
   * </code>
   *
   * @return Whether the eventTrigger field is set.
   */
  boolean hasEventTrigger();
  /**
   *
   *
   * <pre>
   * Optional. Specifies an event to log when a user joins the Audience. If not
   * set, no event is logged when a user joins the Audience.
   * </pre>
   *
   * <code>
   * .google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];
   * </code>
   *
   * @return The eventTrigger.
   */
  com.google.analytics.admin.v1alpha.AudienceEventTrigger getEventTrigger();
  /**
   *
   *
   * <pre>
   * Optional. Specifies an event to log when a user joins the Audience. If not
   * set, no event is logged when a user joins the Audience.
   * </pre>
   *
   * <code>
   * .google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];
   * </code>
   */
  com.google.analytics.admin.v1alpha.AudienceEventTriggerOrBuilder getEventTriggerOrBuilder();

  /**
   *
   *
   * <pre>
   * Immutable. Specifies how long an exclusion lasts for users that meet the
   * exclusion filter. It is applied to all EXCLUDE filter clauses and is
   * ignored when there is no EXCLUDE filter clause in the Audience.
   * </pre>
   *
   * <code>
   * .google.analytics.admin.v1alpha.Audience.AudienceExclusionDurationMode exclusion_duration_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];
   * </code>
   *
   * @return The enum numeric value on the wire for exclusionDurationMode.
   */
  int getExclusionDurationModeValue();
  /**
   *
   *
   * <pre>
   * Immutable. Specifies how long an exclusion lasts for users that meet the
   * exclusion filter. It is applied to all EXCLUDE filter clauses and is
   * ignored when there is no EXCLUDE filter clause in the Audience.
   * </pre>
   *
   * <code>
   * .google.analytics.admin.v1alpha.Audience.AudienceExclusionDurationMode exclusion_duration_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];
   * </code>
   *
   * @return The exclusionDurationMode.
   */
  com.google.analytics.admin.v1alpha.Audience.AudienceExclusionDurationMode
      getExclusionDurationMode();

  /**
   *
   *
   * <pre>
   * Required. Immutable. Unordered list. Filter clauses that define the
   * Audience. All clauses will be AND’ed together.
   * </pre>
   *
   * <code>
   * repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
   * </code>
   */
  java.util.List<com.google.analytics.admin.v1alpha.AudienceFilterClause> getFilterClausesList();
  /**
   *
   *
   * <pre>
   * Required. Immutable. Unordered list. Filter clauses that define the
   * Audience. All clauses will be AND’ed together.
   * </pre>
   *
   * <code>
   * repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
   * </code>
   */
  com.google.analytics.admin.v1alpha.AudienceFilterClause getFilterClauses(int index);
  /**
   *
   *
   * <pre>
   * Required. Immutable. Unordered list. Filter clauses that define the
   * Audience. All clauses will be AND’ed together.
   * </pre>
   *
   * <code>
   * repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
   * </code>
   */
  int getFilterClausesCount();
  /**
   *
   *
   * <pre>
   * Required. Immutable. Unordered list. Filter clauses that define the
   * Audience. All clauses will be AND’ed together.
   * </pre>
   *
   * <code>
   * repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
   * </code>
   */
  java.util.List<? extends com.google.analytics.admin.v1alpha.AudienceFilterClauseOrBuilder>
      getFilterClausesOrBuilderList();
  /**
   *
   *
   * <pre>
   * Required. Immutable. Unordered list. Filter clauses that define the
   * Audience. All clauses will be AND’ed together.
   * </pre>
   *
   * <code>
   * repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
   * </code>
   */
  com.google.analytics.admin.v1alpha.AudienceFilterClauseOrBuilder getFilterClausesOrBuilder(
      int index);
}
