1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/analytics/data/v1beta/data.proto 18 19 package com.google.analytics.data.v1beta; 20 21 public interface DimensionMetadataOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.analytics.data.v1beta.DimensionMetadata) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For 31 * example, `eventName`. 32 * </pre> 33 * 34 * <code>string api_name = 1;</code> 35 * 36 * @return The apiName. 37 */ getApiName()38 java.lang.String getApiName(); 39 /** 40 * 41 * 42 * <pre> 43 * This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For 44 * example, `eventName`. 45 * </pre> 46 * 47 * <code>string api_name = 1;</code> 48 * 49 * @return The bytes for apiName. 50 */ getApiNameBytes()51 com.google.protobuf.ByteString getApiNameBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * This dimension's name within the Google Analytics user interface. For 58 * example, `Event name`. 59 * </pre> 60 * 61 * <code>string ui_name = 2;</code> 62 * 63 * @return The uiName. 64 */ getUiName()65 java.lang.String getUiName(); 66 /** 67 * 68 * 69 * <pre> 70 * This dimension's name within the Google Analytics user interface. For 71 * example, `Event name`. 72 * </pre> 73 * 74 * <code>string ui_name = 2;</code> 75 * 76 * @return The bytes for uiName. 77 */ getUiNameBytes()78 com.google.protobuf.ByteString getUiNameBytes(); 79 80 /** 81 * 82 * 83 * <pre> 84 * Description of how this dimension is used and calculated. 85 * </pre> 86 * 87 * <code>string description = 3;</code> 88 * 89 * @return The description. 90 */ getDescription()91 java.lang.String getDescription(); 92 /** 93 * 94 * 95 * <pre> 96 * Description of how this dimension is used and calculated. 97 * </pre> 98 * 99 * <code>string description = 3;</code> 100 * 101 * @return The bytes for description. 102 */ getDescriptionBytes()103 com.google.protobuf.ByteString getDescriptionBytes(); 104 105 /** 106 * 107 * 108 * <pre> 109 * Still usable but deprecated names for this dimension. If populated, this 110 * dimension is available by either `apiName` or one of `deprecatedApiNames` 111 * for a period of time. After the deprecation period, the dimension will be 112 * available only by `apiName`. 113 * </pre> 114 * 115 * <code>repeated string deprecated_api_names = 4;</code> 116 * 117 * @return A list containing the deprecatedApiNames. 118 */ getDeprecatedApiNamesList()119 java.util.List<java.lang.String> getDeprecatedApiNamesList(); 120 /** 121 * 122 * 123 * <pre> 124 * Still usable but deprecated names for this dimension. If populated, this 125 * dimension is available by either `apiName` or one of `deprecatedApiNames` 126 * for a period of time. After the deprecation period, the dimension will be 127 * available only by `apiName`. 128 * </pre> 129 * 130 * <code>repeated string deprecated_api_names = 4;</code> 131 * 132 * @return The count of deprecatedApiNames. 133 */ getDeprecatedApiNamesCount()134 int getDeprecatedApiNamesCount(); 135 /** 136 * 137 * 138 * <pre> 139 * Still usable but deprecated names for this dimension. If populated, this 140 * dimension is available by either `apiName` or one of `deprecatedApiNames` 141 * for a period of time. After the deprecation period, the dimension will be 142 * available only by `apiName`. 143 * </pre> 144 * 145 * <code>repeated string deprecated_api_names = 4;</code> 146 * 147 * @param index The index of the element to return. 148 * @return The deprecatedApiNames at the given index. 149 */ getDeprecatedApiNames(int index)150 java.lang.String getDeprecatedApiNames(int index); 151 /** 152 * 153 * 154 * <pre> 155 * Still usable but deprecated names for this dimension. If populated, this 156 * dimension is available by either `apiName` or one of `deprecatedApiNames` 157 * for a period of time. After the deprecation period, the dimension will be 158 * available only by `apiName`. 159 * </pre> 160 * 161 * <code>repeated string deprecated_api_names = 4;</code> 162 * 163 * @param index The index of the value to return. 164 * @return The bytes of the deprecatedApiNames at the given index. 165 */ getDeprecatedApiNamesBytes(int index)166 com.google.protobuf.ByteString getDeprecatedApiNamesBytes(int index); 167 168 /** 169 * 170 * 171 * <pre> 172 * True if the dimension is a custom dimension for this property. 173 * </pre> 174 * 175 * <code>bool custom_definition = 5;</code> 176 * 177 * @return The customDefinition. 178 */ getCustomDefinition()179 boolean getCustomDefinition(); 180 181 /** 182 * 183 * 184 * <pre> 185 * The display name of the category that this dimension belongs to. Similar 186 * dimensions and metrics are categorized together. 187 * </pre> 188 * 189 * <code>string category = 7;</code> 190 * 191 * @return The category. 192 */ getCategory()193 java.lang.String getCategory(); 194 /** 195 * 196 * 197 * <pre> 198 * The display name of the category that this dimension belongs to. Similar 199 * dimensions and metrics are categorized together. 200 * </pre> 201 * 202 * <code>string category = 7;</code> 203 * 204 * @return The bytes for category. 205 */ getCategoryBytes()206 com.google.protobuf.ByteString getCategoryBytes(); 207 } 208