/*
 * Copyright 2020 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/expanded_data_set.proto

package com.google.analytics.admin.v1alpha;

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

  /**
   *
   *
   * <pre>
   * Output only. The resource name for this ExpandedDataSet resource.
   * Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
   * </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 ExpandedDataSet resource.
   * Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
   * </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 ExpandedDataSet.
   * Max 200 chars.
   * </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 ExpandedDataSet.
   * Max 200 chars.
   * </pre>
   *
   * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code>
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   * <pre>
   * Optional. The description of the ExpandedDataSet.
   * Max 50 chars.
   * </pre>
   *
   * <code>string description = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   * <pre>
   * Optional. The description of the ExpandedDataSet.
   * Max 50 chars.
   * </pre>
   *
   * <code>string description = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   * <pre>
   * Immutable. The list of dimensions included in the ExpandedDataSet.
   * See the [API
   * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
   * for the list of dimension names.
   * </pre>
   *
   * <code>repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @return A list containing the dimensionNames.
   */
  java.util.List<java.lang.String> getDimensionNamesList();
  /**
   *
   *
   * <pre>
   * Immutable. The list of dimensions included in the ExpandedDataSet.
   * See the [API
   * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
   * for the list of dimension names.
   * </pre>
   *
   * <code>repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @return The count of dimensionNames.
   */
  int getDimensionNamesCount();
  /**
   *
   *
   * <pre>
   * Immutable. The list of dimensions included in the ExpandedDataSet.
   * See the [API
   * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
   * for the list of dimension names.
   * </pre>
   *
   * <code>repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @param index The index of the element to return.
   * @return The dimensionNames at the given index.
   */
  java.lang.String getDimensionNames(int index);
  /**
   *
   *
   * <pre>
   * Immutable. The list of dimensions included in the ExpandedDataSet.
   * See the [API
   * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
   * for the list of dimension names.
   * </pre>
   *
   * <code>repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @param index The index of the value to return.
   * @return The bytes of the dimensionNames at the given index.
   */
  com.google.protobuf.ByteString getDimensionNamesBytes(int index);

  /**
   *
   *
   * <pre>
   * Immutable. The list of metrics included in the ExpandedDataSet.
   * See the [API
   * Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
   * for the list of dimension names.
   * </pre>
   *
   * <code>repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @return A list containing the metricNames.
   */
  java.util.List<java.lang.String> getMetricNamesList();
  /**
   *
   *
   * <pre>
   * Immutable. The list of metrics included in the ExpandedDataSet.
   * See the [API
   * Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
   * for the list of dimension names.
   * </pre>
   *
   * <code>repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @return The count of metricNames.
   */
  int getMetricNamesCount();
  /**
   *
   *
   * <pre>
   * Immutable. The list of metrics included in the ExpandedDataSet.
   * See the [API
   * Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
   * for the list of dimension names.
   * </pre>
   *
   * <code>repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @param index The index of the element to return.
   * @return The metricNames at the given index.
   */
  java.lang.String getMetricNames(int index);
  /**
   *
   *
   * <pre>
   * Immutable. The list of metrics included in the ExpandedDataSet.
   * See the [API
   * Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
   * for the list of dimension names.
   * </pre>
   *
   * <code>repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @param index The index of the value to return.
   * @return The bytes of the metricNames at the given index.
   */
  com.google.protobuf.ByteString getMetricNamesBytes(int index);

  /**
   *
   *
   * <pre>
   * Immutable. A logical expression of ExpandedDataSet filters applied to
   * dimension included in the ExpandedDataSet. This filter is used to reduce
   * the number of rows and thus the chance of encountering `other` row.
   * </pre>
   *
   * <code>
   * .google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];
   * </code>
   *
   * @return Whether the dimensionFilterExpression field is set.
   */
  boolean hasDimensionFilterExpression();
  /**
   *
   *
   * <pre>
   * Immutable. A logical expression of ExpandedDataSet filters applied to
   * dimension included in the ExpandedDataSet. This filter is used to reduce
   * the number of rows and thus the chance of encountering `other` row.
   * </pre>
   *
   * <code>
   * .google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];
   * </code>
   *
   * @return The dimensionFilterExpression.
   */
  com.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression getDimensionFilterExpression();
  /**
   *
   *
   * <pre>
   * Immutable. A logical expression of ExpandedDataSet filters applied to
   * dimension included in the ExpandedDataSet. This filter is used to reduce
   * the number of rows and thus the chance of encountering `other` row.
   * </pre>
   *
   * <code>
   * .google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE];
   * </code>
   */
  com.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpressionOrBuilder
      getDimensionFilterExpressionOrBuilder();

  /**
   *
   *
   * <pre>
   * Output only. Time when expanded data set began (or will begin) collecing
   * data.
   * </pre>
   *
   * <code>
   * .google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return Whether the dataCollectionStartTime field is set.
   */
  boolean hasDataCollectionStartTime();
  /**
   *
   *
   * <pre>
   * Output only. Time when expanded data set began (or will begin) collecing
   * data.
   * </pre>
   *
   * <code>
   * .google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The dataCollectionStartTime.
   */
  com.google.protobuf.Timestamp getDataCollectionStartTime();
  /**
   *
   *
   * <pre>
   * Output only. Time when expanded data set began (or will begin) collecing
   * data.
   * </pre>
   *
   * <code>
   * .google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  com.google.protobuf.TimestampOrBuilder getDataCollectionStartTimeOrBuilder();
}