+ * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The apiKey.
+ */
+ java.lang.String getApiKey();
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The bytes for apiKey.
+ */
+ com.google.protobuf.ByteString getApiKeyBytes();
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the customConfigs field is set.
+ */
+ boolean hasCustomConfigs();
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The customConfigs.
+ */
+ com.google.protobuf.Struct getCustomConfigs();
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ com.google.protobuf.StructOrBuilder getCustomConfigsOrBuilder();
+ }
+
+ /**
+ *
+ *
+ * + * ParallelAiSearch tool type. + * A tool that uses the Parallel.ai search engine for grounding. + *+ * + * Protobuf type {@code google.cloud.aiplatform.v1.Tool.ParallelAiSearch} + */ + public static final class ParallelAiSearch extends com.google.protobuf.GeneratedMessage + implements + // @@protoc_insertion_point(message_implements:google.cloud.aiplatform.v1.Tool.ParallelAiSearch) + ParallelAiSearchOrBuilder { + private static final long serialVersionUID = 0L; + + static { + com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion( + com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC, + /* major= */ 4, + /* minor= */ 33, + /* patch= */ 2, + /* suffix= */ "", + "ParallelAiSearch"); + } + + // Use ParallelAiSearch.newBuilder() to construct. + private ParallelAiSearch(com.google.protobuf.GeneratedMessage.Builder builder) { + super(builder); + } + + private ParallelAiSearch() { + apiKey_ = ""; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.cloud.aiplatform.v1.ToolProto + .internal_static_google_cloud_aiplatform_v1_Tool_ParallelAiSearch_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.cloud.aiplatform.v1.ToolProto + .internal_static_google_cloud_aiplatform_v1_Tool_ParallelAiSearch_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.class, + com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.Builder.class); + } + + private int bitField0_; + public static final int API_KEY_FIELD_NUMBER = 1; + + @SuppressWarnings("serial") + private volatile java.lang.Object apiKey_ = ""; + + /** + * + * + *
+ * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The apiKey.
+ */
+ @java.lang.Override
+ public java.lang.String getApiKey() {
+ java.lang.Object ref = apiKey_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ apiKey_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The bytes for apiKey.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getApiKeyBytes() {
+ java.lang.Object ref = apiKey_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ apiKey_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int CUSTOM_CONFIGS_FIELD_NUMBER = 3;
+ private com.google.protobuf.Struct customConfigs_;
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the customConfigs field is set.
+ */
+ @java.lang.Override
+ public boolean hasCustomConfigs() {
+ return ((bitField0_ & 0x00000001) != 0);
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The customConfigs.
+ */
+ @java.lang.Override
+ public com.google.protobuf.Struct getCustomConfigs() {
+ return customConfigs_ == null
+ ? com.google.protobuf.Struct.getDefaultInstance()
+ : customConfigs_;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ @java.lang.Override
+ public com.google.protobuf.StructOrBuilder getCustomConfigsOrBuilder() {
+ return customConfigs_ == null
+ ? com.google.protobuf.Struct.getDefaultInstance()
+ : customConfigs_;
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(apiKey_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 1, apiKey_);
+ }
+ if (((bitField0_ & 0x00000001) != 0)) {
+ output.writeMessage(3, getCustomConfigs());
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(apiKey_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(1, apiKey_);
+ }
+ if (((bitField0_ & 0x00000001) != 0)) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(3, getCustomConfigs());
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch)) {
+ return super.equals(obj);
+ }
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch other =
+ (com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch) obj;
+
+ if (!getApiKey().equals(other.getApiKey())) return false;
+ if (hasCustomConfigs() != other.hasCustomConfigs()) return false;
+ if (hasCustomConfigs()) {
+ if (!getCustomConfigs().equals(other.getCustomConfigs())) return false;
+ }
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ hash = (37 * hash) + API_KEY_FIELD_NUMBER;
+ hash = (53 * hash) + getApiKey().hashCode();
+ if (hasCustomConfigs()) {
+ hash = (37 * hash) + CUSTOM_CONFIGS_FIELD_NUMBER;
+ hash = (53 * hash) + getCustomConfigs().hashCode();
+ }
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(byte[] data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+
+ /**
+ *
+ *
+ * + * ParallelAiSearch tool type. + * A tool that uses the Parallel.ai search engine for grounding. + *+ * + * Protobuf type {@code google.cloud.aiplatform.v1.Tool.ParallelAiSearch} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessage.Builder
+ * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The apiKey.
+ */
+ public java.lang.String getApiKey() {
+ java.lang.Object ref = apiKey_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ apiKey_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The bytes for apiKey.
+ */
+ public com.google.protobuf.ByteString getApiKeyBytes() {
+ java.lang.Object ref = apiKey_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ apiKey_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @param value The apiKey to set.
+ * @return This builder for chaining.
+ */
+ public Builder setApiKey(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ apiKey_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearApiKey() {
+ apiKey_ = getDefaultInstance().getApiKey();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @param value The bytes for apiKey to set.
+ * @return This builder for chaining.
+ */
+ public Builder setApiKeyBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ apiKey_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private com.google.protobuf.Struct customConfigs_;
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.protobuf.Struct,
+ com.google.protobuf.Struct.Builder,
+ com.google.protobuf.StructOrBuilder>
+ customConfigsBuilder_;
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the customConfigs field is set.
+ */
+ public boolean hasCustomConfigs() {
+ return ((bitField0_ & 0x00000002) != 0);
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The customConfigs.
+ */
+ public com.google.protobuf.Struct getCustomConfigs() {
+ if (customConfigsBuilder_ == null) {
+ return customConfigs_ == null
+ ? com.google.protobuf.Struct.getDefaultInstance()
+ : customConfigs_;
+ } else {
+ return customConfigsBuilder_.getMessage();
+ }
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder setCustomConfigs(com.google.protobuf.Struct value) {
+ if (customConfigsBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ customConfigs_ = value;
+ } else {
+ customConfigsBuilder_.setMessage(value);
+ }
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder setCustomConfigs(com.google.protobuf.Struct.Builder builderForValue) {
+ if (customConfigsBuilder_ == null) {
+ customConfigs_ = builderForValue.build();
+ } else {
+ customConfigsBuilder_.setMessage(builderForValue.build());
+ }
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder mergeCustomConfigs(com.google.protobuf.Struct value) {
+ if (customConfigsBuilder_ == null) {
+ if (((bitField0_ & 0x00000002) != 0)
+ && customConfigs_ != null
+ && customConfigs_ != com.google.protobuf.Struct.getDefaultInstance()) {
+ getCustomConfigsBuilder().mergeFrom(value);
+ } else {
+ customConfigs_ = value;
+ }
+ } else {
+ customConfigsBuilder_.mergeFrom(value);
+ }
+ if (customConfigs_ != null) {
+ bitField0_ |= 0x00000002;
+ onChanged();
+ }
+ return this;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder clearCustomConfigs() {
+ bitField0_ = (bitField0_ & ~0x00000002);
+ customConfigs_ = null;
+ if (customConfigsBuilder_ != null) {
+ customConfigsBuilder_.dispose();
+ customConfigsBuilder_ = null;
+ }
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public com.google.protobuf.Struct.Builder getCustomConfigsBuilder() {
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return internalGetCustomConfigsFieldBuilder().getBuilder();
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public com.google.protobuf.StructOrBuilder getCustomConfigsOrBuilder() {
+ if (customConfigsBuilder_ != null) {
+ return customConfigsBuilder_.getMessageOrBuilder();
+ } else {
+ return customConfigs_ == null
+ ? com.google.protobuf.Struct.getDefaultInstance()
+ : customConfigs_;
+ }
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.protobuf.Struct,
+ com.google.protobuf.Struct.Builder,
+ com.google.protobuf.StructOrBuilder>
+ internalGetCustomConfigsFieldBuilder() {
+ if (customConfigsBuilder_ == null) {
+ customConfigsBuilder_ =
+ new com.google.protobuf.SingleFieldBuilder<
+ com.google.protobuf.Struct,
+ com.google.protobuf.Struct.Builder,
+ com.google.protobuf.StructOrBuilder>(
+ getCustomConfigs(), getParentForChildren(), isClean());
+ customConfigs_ = null;
+ }
+ return customConfigsBuilder_;
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.cloud.aiplatform.v1.Tool.ParallelAiSearch)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.cloud.aiplatform.v1.Tool.ParallelAiSearch)
+ private static final com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch();
+ }
+
+ public static com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser+ * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the parallelAiSearch field is set.
+ */
+ @java.lang.Override
+ public boolean hasParallelAiSearch() {
+ return ((bitField0_ & 0x00000020) != 0);
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The parallelAiSearch.
+ */
+ @java.lang.Override
+ public com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch getParallelAiSearch() {
+ return parallelAiSearch_ == null
+ ? com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.getDefaultInstance()
+ : parallelAiSearch_;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ @java.lang.Override
+ public com.google.cloud.aiplatform.v1.Tool.ParallelAiSearchOrBuilder
+ getParallelAiSearchOrBuilder() {
+ return parallelAiSearch_ == null
+ ? com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.getDefaultInstance()
+ : parallelAiSearch_;
+ }
+
public static final int CODE_EXECUTION_FIELD_NUMBER = 4;
private com.google.cloud.aiplatform.v1.Tool.CodeExecution codeExecution_;
@@ -3461,7 +4758,7 @@ public com.google.cloud.aiplatform.v1.EnterpriseWebSearch getEnterpriseWebSearch
*/
@java.lang.Override
public boolean hasCodeExecution() {
- return ((bitField0_ & 0x00000020) != 0);
+ return ((bitField0_ & 0x00000040) != 0);
}
/**
@@ -3522,7 +4819,7 @@ public com.google.cloud.aiplatform.v1.Tool.CodeExecutionOrBuilder getCodeExecuti
*/
@java.lang.Override
public boolean hasUrlContext() {
- return ((bitField0_ & 0x00000040) != 0);
+ return ((bitField0_ & 0x00000080) != 0);
}
/**
@@ -3583,7 +4880,7 @@ public com.google.cloud.aiplatform.v1.UrlContextOrBuilder getUrlContextOrBuilder
*/
@java.lang.Override
public boolean hasComputerUse() {
- return ((bitField0_ & 0x00000080) != 0);
+ return ((bitField0_ & 0x00000100) != 0);
}
/**
@@ -3651,7 +4948,7 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (((bitField0_ & 0x00000004) != 0)) {
output.writeMessage(3, getGoogleSearchRetrieval());
}
- if (((bitField0_ & 0x00000020) != 0)) {
+ if (((bitField0_ & 0x00000040) != 0)) {
output.writeMessage(4, getCodeExecution());
}
if (((bitField0_ & 0x00000008) != 0)) {
@@ -3663,12 +4960,15 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (((bitField0_ & 0x00000002) != 0)) {
output.writeMessage(7, getGoogleSearch());
}
- if (((bitField0_ & 0x00000040) != 0)) {
+ if (((bitField0_ & 0x00000080) != 0)) {
output.writeMessage(10, getUrlContext());
}
- if (((bitField0_ & 0x00000080) != 0)) {
+ if (((bitField0_ & 0x00000100) != 0)) {
output.writeMessage(11, getComputerUse());
}
+ if (((bitField0_ & 0x00000020) != 0)) {
+ output.writeMessage(13, getParallelAiSearch());
+ }
getUnknownFields().writeTo(output);
}
@@ -3689,7 +4989,7 @@ public int getSerializedSize() {
size +=
com.google.protobuf.CodedOutputStream.computeMessageSize(3, getGoogleSearchRetrieval());
}
- if (((bitField0_ & 0x00000020) != 0)) {
+ if (((bitField0_ & 0x00000040) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, getCodeExecution());
}
if (((bitField0_ & 0x00000008) != 0)) {
@@ -3701,12 +5001,15 @@ public int getSerializedSize() {
if (((bitField0_ & 0x00000002) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(7, getGoogleSearch());
}
- if (((bitField0_ & 0x00000040) != 0)) {
+ if (((bitField0_ & 0x00000080) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(10, getUrlContext());
}
- if (((bitField0_ & 0x00000080) != 0)) {
+ if (((bitField0_ & 0x00000100) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(11, getComputerUse());
}
+ if (((bitField0_ & 0x00000020) != 0)) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(13, getParallelAiSearch());
+ }
size += getUnknownFields().getSerializedSize();
memoizedSize = size;
return size;
@@ -3743,6 +5046,10 @@ public boolean equals(final java.lang.Object obj) {
if (hasEnterpriseWebSearch()) {
if (!getEnterpriseWebSearch().equals(other.getEnterpriseWebSearch())) return false;
}
+ if (hasParallelAiSearch() != other.hasParallelAiSearch()) return false;
+ if (hasParallelAiSearch()) {
+ if (!getParallelAiSearch().equals(other.getParallelAiSearch())) return false;
+ }
if (hasCodeExecution() != other.hasCodeExecution()) return false;
if (hasCodeExecution()) {
if (!getCodeExecution().equals(other.getCodeExecution())) return false;
@@ -3790,6 +5097,10 @@ public int hashCode() {
hash = (37 * hash) + ENTERPRISE_WEB_SEARCH_FIELD_NUMBER;
hash = (53 * hash) + getEnterpriseWebSearch().hashCode();
}
+ if (hasParallelAiSearch()) {
+ hash = (37 * hash) + PARALLEL_AI_SEARCH_FIELD_NUMBER;
+ hash = (53 * hash) + getParallelAiSearch().hashCode();
+ }
if (hasCodeExecution()) {
hash = (37 * hash) + CODE_EXECUTION_FIELD_NUMBER;
hash = (53 * hash) + getCodeExecution().hashCode();
@@ -3954,6 +5265,7 @@ private void maybeForceBuilderInitialization() {
internalGetGoogleSearchRetrievalFieldBuilder();
internalGetGoogleMapsFieldBuilder();
internalGetEnterpriseWebSearchFieldBuilder();
+ internalGetParallelAiSearchFieldBuilder();
internalGetCodeExecutionFieldBuilder();
internalGetUrlContextFieldBuilder();
internalGetComputerUseFieldBuilder();
@@ -3996,6 +5308,11 @@ public Builder clear() {
enterpriseWebSearchBuilder_.dispose();
enterpriseWebSearchBuilder_ = null;
}
+ parallelAiSearch_ = null;
+ if (parallelAiSearchBuilder_ != null) {
+ parallelAiSearchBuilder_.dispose();
+ parallelAiSearchBuilder_ = null;
+ }
codeExecution_ = null;
if (codeExecutionBuilder_ != null) {
codeExecutionBuilder_.dispose();
@@ -4088,18 +5405,23 @@ private void buildPartial0(com.google.cloud.aiplatform.v1.Tool result) {
to_bitField0_ |= 0x00000010;
}
if (((from_bitField0_ & 0x00000040) != 0)) {
- result.codeExecution_ =
- codeExecutionBuilder_ == null ? codeExecution_ : codeExecutionBuilder_.build();
+ result.parallelAiSearch_ =
+ parallelAiSearchBuilder_ == null ? parallelAiSearch_ : parallelAiSearchBuilder_.build();
to_bitField0_ |= 0x00000020;
}
if (((from_bitField0_ & 0x00000080) != 0)) {
- result.urlContext_ = urlContextBuilder_ == null ? urlContext_ : urlContextBuilder_.build();
+ result.codeExecution_ =
+ codeExecutionBuilder_ == null ? codeExecution_ : codeExecutionBuilder_.build();
to_bitField0_ |= 0x00000040;
}
if (((from_bitField0_ & 0x00000100) != 0)) {
+ result.urlContext_ = urlContextBuilder_ == null ? urlContext_ : urlContextBuilder_.build();
+ to_bitField0_ |= 0x00000080;
+ }
+ if (((from_bitField0_ & 0x00000200) != 0)) {
result.computerUse_ =
computerUseBuilder_ == null ? computerUse_ : computerUseBuilder_.build();
- to_bitField0_ |= 0x00000080;
+ to_bitField0_ |= 0x00000100;
}
result.bitField0_ |= to_bitField0_;
}
@@ -4158,6 +5480,9 @@ public Builder mergeFrom(com.google.cloud.aiplatform.v1.Tool other) {
if (other.hasEnterpriseWebSearch()) {
mergeEnterpriseWebSearch(other.getEnterpriseWebSearch());
}
+ if (other.hasParallelAiSearch()) {
+ mergeParallelAiSearch(other.getParallelAiSearch());
+ }
if (other.hasCodeExecution()) {
mergeCodeExecution(other.getCodeExecution());
}
@@ -4225,7 +5550,7 @@ public Builder mergeFrom(
{
input.readMessage(
internalGetCodeExecutionFieldBuilder().getBuilder(), extensionRegistry);
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
break;
} // case 34
case 42:
@@ -4253,16 +5578,23 @@ public Builder mergeFrom(
{
input.readMessage(
internalGetUrlContextFieldBuilder().getBuilder(), extensionRegistry);
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
break;
} // case 82
case 90:
{
input.readMessage(
internalGetComputerUseFieldBuilder().getBuilder(), extensionRegistry);
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
break;
} // case 90
+ case 106:
+ {
+ input.readMessage(
+ internalGetParallelAiSearchFieldBuilder().getBuilder(), extensionRegistry);
+ bitField0_ |= 0x00000040;
+ break;
+ } // case 106
default:
{
if (!super.parseUnknownField(input, extensionRegistry, tag)) {
@@ -5981,6 +7313,241 @@ public Builder clearEnterpriseWebSearch() {
return enterpriseWebSearchBuilder_;
}
+ private com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallelAiSearch_;
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch,
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.Builder,
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearchOrBuilder>
+ parallelAiSearchBuilder_;
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the parallelAiSearch field is set.
+ */
+ public boolean hasParallelAiSearch() {
+ return ((bitField0_ & 0x00000040) != 0);
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The parallelAiSearch.
+ */
+ public com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch getParallelAiSearch() {
+ if (parallelAiSearchBuilder_ == null) {
+ return parallelAiSearch_ == null
+ ? com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.getDefaultInstance()
+ : parallelAiSearch_;
+ } else {
+ return parallelAiSearchBuilder_.getMessage();
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder setParallelAiSearch(com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch value) {
+ if (parallelAiSearchBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ parallelAiSearch_ = value;
+ } else {
+ parallelAiSearchBuilder_.setMessage(value);
+ }
+ bitField0_ |= 0x00000040;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder setParallelAiSearch(
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.Builder builderForValue) {
+ if (parallelAiSearchBuilder_ == null) {
+ parallelAiSearch_ = builderForValue.build();
+ } else {
+ parallelAiSearchBuilder_.setMessage(builderForValue.build());
+ }
+ bitField0_ |= 0x00000040;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder mergeParallelAiSearch(
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch value) {
+ if (parallelAiSearchBuilder_ == null) {
+ if (((bitField0_ & 0x00000040) != 0)
+ && parallelAiSearch_ != null
+ && parallelAiSearch_
+ != com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.getDefaultInstance()) {
+ getParallelAiSearchBuilder().mergeFrom(value);
+ } else {
+ parallelAiSearch_ = value;
+ }
+ } else {
+ parallelAiSearchBuilder_.mergeFrom(value);
+ }
+ if (parallelAiSearch_ != null) {
+ bitField0_ |= 0x00000040;
+ onChanged();
+ }
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder clearParallelAiSearch() {
+ bitField0_ = (bitField0_ & ~0x00000040);
+ parallelAiSearch_ = null;
+ if (parallelAiSearchBuilder_ != null) {
+ parallelAiSearchBuilder_.dispose();
+ parallelAiSearchBuilder_ = null;
+ }
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.Builder
+ getParallelAiSearchBuilder() {
+ bitField0_ |= 0x00000040;
+ onChanged();
+ return internalGetParallelAiSearchFieldBuilder().getBuilder();
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public com.google.cloud.aiplatform.v1.Tool.ParallelAiSearchOrBuilder
+ getParallelAiSearchOrBuilder() {
+ if (parallelAiSearchBuilder_ != null) {
+ return parallelAiSearchBuilder_.getMessageOrBuilder();
+ } else {
+ return parallelAiSearch_ == null
+ ? com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.getDefaultInstance()
+ : parallelAiSearch_;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch,
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.Builder,
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearchOrBuilder>
+ internalGetParallelAiSearchFieldBuilder() {
+ if (parallelAiSearchBuilder_ == null) {
+ parallelAiSearchBuilder_ =
+ new com.google.protobuf.SingleFieldBuilder<
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch,
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.Builder,
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearchOrBuilder>(
+ getParallelAiSearch(), getParentForChildren(), isClean());
+ parallelAiSearch_ = null;
+ }
+ return parallelAiSearchBuilder_;
+ }
+
private com.google.cloud.aiplatform.v1.Tool.CodeExecution codeExecution_;
private com.google.protobuf.SingleFieldBuilder<
com.google.cloud.aiplatform.v1.Tool.CodeExecution,
@@ -6003,7 +7570,7 @@ public Builder clearEnterpriseWebSearch() {
* @return Whether the codeExecution field is set.
*/
public boolean hasCodeExecution() {
- return ((bitField0_ & 0x00000040) != 0);
+ return ((bitField0_ & 0x00000080) != 0);
}
/**
@@ -6051,7 +7618,7 @@ public Builder setCodeExecution(com.google.cloud.aiplatform.v1.Tool.CodeExecutio
} else {
codeExecutionBuilder_.setMessage(value);
}
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
onChanged();
return this;
}
@@ -6075,7 +7642,7 @@ public Builder setCodeExecution(
} else {
codeExecutionBuilder_.setMessage(builderForValue.build());
}
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
onChanged();
return this;
}
@@ -6094,7 +7661,7 @@ public Builder setCodeExecution(
*/
public Builder mergeCodeExecution(com.google.cloud.aiplatform.v1.Tool.CodeExecution value) {
if (codeExecutionBuilder_ == null) {
- if (((bitField0_ & 0x00000040) != 0)
+ if (((bitField0_ & 0x00000080) != 0)
&& codeExecution_ != null
&& codeExecution_
!= com.google.cloud.aiplatform.v1.Tool.CodeExecution.getDefaultInstance()) {
@@ -6106,7 +7673,7 @@ public Builder mergeCodeExecution(com.google.cloud.aiplatform.v1.Tool.CodeExecut
codeExecutionBuilder_.mergeFrom(value);
}
if (codeExecution_ != null) {
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
onChanged();
}
return this;
@@ -6125,7 +7692,7 @@ public Builder mergeCodeExecution(com.google.cloud.aiplatform.v1.Tool.CodeExecut
*
*/
public Builder clearCodeExecution() {
- bitField0_ = (bitField0_ & ~0x00000040);
+ bitField0_ = (bitField0_ & ~0x00000080);
codeExecution_ = null;
if (codeExecutionBuilder_ != null) {
codeExecutionBuilder_.dispose();
@@ -6148,7 +7715,7 @@ public Builder clearCodeExecution() {
*
*/
public com.google.cloud.aiplatform.v1.Tool.CodeExecution.Builder getCodeExecutionBuilder() {
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
onChanged();
return internalGetCodeExecutionFieldBuilder().getBuilder();
}
@@ -6225,7 +7792,7 @@ public com.google.cloud.aiplatform.v1.Tool.CodeExecutionOrBuilder getCodeExecuti
* @return Whether the urlContext field is set.
*/
public boolean hasUrlContext() {
- return ((bitField0_ & 0x00000080) != 0);
+ return ((bitField0_ & 0x00000100) != 0);
}
/**
@@ -6271,7 +7838,7 @@ public Builder setUrlContext(com.google.cloud.aiplatform.v1.UrlContext value) {
} else {
urlContextBuilder_.setMessage(value);
}
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
onChanged();
return this;
}
@@ -6294,7 +7861,7 @@ public Builder setUrlContext(
} else {
urlContextBuilder_.setMessage(builderForValue.build());
}
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
onChanged();
return this;
}
@@ -6312,7 +7879,7 @@ public Builder setUrlContext(
*/
public Builder mergeUrlContext(com.google.cloud.aiplatform.v1.UrlContext value) {
if (urlContextBuilder_ == null) {
- if (((bitField0_ & 0x00000080) != 0)
+ if (((bitField0_ & 0x00000100) != 0)
&& urlContext_ != null
&& urlContext_ != com.google.cloud.aiplatform.v1.UrlContext.getDefaultInstance()) {
getUrlContextBuilder().mergeFrom(value);
@@ -6323,7 +7890,7 @@ public Builder mergeUrlContext(com.google.cloud.aiplatform.v1.UrlContext value)
urlContextBuilder_.mergeFrom(value);
}
if (urlContext_ != null) {
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
onChanged();
}
return this;
@@ -6341,7 +7908,7 @@ public Builder mergeUrlContext(com.google.cloud.aiplatform.v1.UrlContext value)
*
*/
public Builder clearUrlContext() {
- bitField0_ = (bitField0_ & ~0x00000080);
+ bitField0_ = (bitField0_ & ~0x00000100);
urlContext_ = null;
if (urlContextBuilder_ != null) {
urlContextBuilder_.dispose();
@@ -6363,7 +7930,7 @@ public Builder clearUrlContext() {
*
*/
public com.google.cloud.aiplatform.v1.UrlContext.Builder getUrlContextBuilder() {
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
onChanged();
return internalGetUrlContextFieldBuilder().getBuilder();
}
@@ -6440,7 +8007,7 @@ public com.google.cloud.aiplatform.v1.UrlContextOrBuilder getUrlContextOrBuilder
* @return Whether the computerUse field is set.
*/
public boolean hasComputerUse() {
- return ((bitField0_ & 0x00000100) != 0);
+ return ((bitField0_ & 0x00000200) != 0);
}
/**
@@ -6490,7 +8057,7 @@ public Builder setComputerUse(com.google.cloud.aiplatform.v1.Tool.ComputerUse va
} else {
computerUseBuilder_.setMessage(value);
}
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
onChanged();
return this;
}
@@ -6515,7 +8082,7 @@ public Builder setComputerUse(
} else {
computerUseBuilder_.setMessage(builderForValue.build());
}
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
onChanged();
return this;
}
@@ -6535,7 +8102,7 @@ public Builder setComputerUse(
*/
public Builder mergeComputerUse(com.google.cloud.aiplatform.v1.Tool.ComputerUse value) {
if (computerUseBuilder_ == null) {
- if (((bitField0_ & 0x00000100) != 0)
+ if (((bitField0_ & 0x00000200) != 0)
&& computerUse_ != null
&& computerUse_
!= com.google.cloud.aiplatform.v1.Tool.ComputerUse.getDefaultInstance()) {
@@ -6547,7 +8114,7 @@ public Builder mergeComputerUse(com.google.cloud.aiplatform.v1.Tool.ComputerUse
computerUseBuilder_.mergeFrom(value);
}
if (computerUse_ != null) {
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
onChanged();
}
return this;
@@ -6567,7 +8134,7 @@ public Builder mergeComputerUse(com.google.cloud.aiplatform.v1.Tool.ComputerUse
*
*/
public Builder clearComputerUse() {
- bitField0_ = (bitField0_ & ~0x00000100);
+ bitField0_ = (bitField0_ & ~0x00000200);
computerUse_ = null;
if (computerUseBuilder_ != null) {
computerUseBuilder_.dispose();
@@ -6591,7 +8158,7 @@ public Builder clearComputerUse() {
*
*/
public com.google.cloud.aiplatform.v1.Tool.ComputerUse.Builder getComputerUseBuilder() {
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
onChanged();
return internalGetComputerUseFieldBuilder().getBuilder();
}
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/ToolOrBuilder.java b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/ToolOrBuilder.java
index 5417ea88a559..7820f38ef488 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/ToolOrBuilder.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/ToolOrBuilder.java
@@ -369,6 +369,55 @@ com.google.cloud.aiplatform.v1.FunctionDeclarationOrBuilder getFunctionDeclarati
*/
com.google.cloud.aiplatform.v1.EnterpriseWebSearchOrBuilder getEnterpriseWebSearchOrBuilder();
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the parallelAiSearch field is set.
+ */
+ boolean hasParallelAiSearch();
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The parallelAiSearch.
+ */
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch getParallelAiSearch();
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ com.google.cloud.aiplatform.v1.Tool.ParallelAiSearchOrBuilder getParallelAiSearchOrBuilder();
+
/**
*
*
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/ToolProto.java b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/ToolProto.java
index 6e6cb5dcd400..a00b0883c9cb 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/ToolProto.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/ToolProto.java
@@ -48,6 +48,10 @@ public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry r
internal_static_google_cloud_aiplatform_v1_Tool_GoogleSearch_descriptor;
static final com.google.protobuf.GeneratedMessage.FieldAccessorTable
internal_static_google_cloud_aiplatform_v1_Tool_GoogleSearch_fieldAccessorTable;
+ static final com.google.protobuf.Descriptors.Descriptor
+ internal_static_google_cloud_aiplatform_v1_Tool_ParallelAiSearch_descriptor;
+ static final com.google.protobuf.GeneratedMessage.FieldAccessorTable
+ internal_static_google_cloud_aiplatform_v1_Tool_ParallelAiSearch_fieldAccessorTable;
static final com.google.protobuf.Descriptors.Descriptor
internal_static_google_cloud_aiplatform_v1_Tool_CodeExecution_descriptor;
static final com.google.protobuf.GeneratedMessage.FieldAccessorTable
@@ -178,7 +182,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\032google.cloud.aiplatform.v1\032\037google/api/"
+ "field_behavior.proto\032\031google/api/resourc"
+ "e.proto\032(google/cloud/aiplatform/v1/open"
- + "api.proto\032\034google/protobuf/struct.proto\032\030google/type/latlng.proto\"\253\n\n"
+ + "api.proto\032\034google/protobuf/struct.proto\032\030google/type/latlng.proto\"\337\013\n"
+ "\004Tool\022S\n"
+ "\025function_declarations\030\001 \003(\0132/.google.cloud"
+ ".aiplatform.v1.FunctionDeclarationB\003\340A\001\022=\n"
@@ -191,23 +195,28 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\013google_maps\030\005"
+ " \001(\0132&.google.cloud.aiplatform.v1.GoogleMapsB\003\340A\001\022S\n"
+ "\025enterprise_web_search\030\006 "
- + "\001(\0132/.google.cloud.aiplatform.v1.EnterpriseWebSearchB\003\340A\001\022K\n"
- + "\016code_execution\030\004 \001("
- + "\0132..google.cloud.aiplatform.v1.Tool.CodeExecutionB\003\340A\001\022@\n"
+ + "\001(\0132/.google.cloud.aiplatform.v1.EnterpriseWebSearchB\003\340A\001\022R\n"
+ + "\022parallel_ai_search\030\r"
+ + " \001(\01321.google.cloud.aiplatform.v1.Tool.ParallelAiSearchB\003\340A\001\022K\n"
+ + "\016code_execution\030\004"
+ + " \001(\0132..google.cloud.aiplatform.v1.Tool.CodeExecutionB\003\340A\001\022@\n"
+ "\013url_context\030\n"
+ " \001(\0132&.google.cloud.aiplatform.v1.UrlContextB\003\340A\001\022G\n"
- + "\014computer_use\030\013"
- + " \001(\0132,.google.cloud.aiplatform.v1.Tool.ComputerUseB\003\340A\001\032\241\001\n"
+ + "\014computer_use\030\013 \001(\0132,.google.clou"
+ + "d.aiplatform.v1.Tool.ComputerUseB\003\340A\001\032\241\001\n"
+ "\014GoogleSearch\022\034\n"
+ "\017exclude_domains\030\003 \003(\tB\003\340A\001\022[\n"
- + "\023blocking_confidence\030\004 \001(\01624.google.c"
- + "loud.aiplatform.v1.Tool.PhishBlockThresholdB\003\340A\001H\000\210\001\001B\026\n"
- + "\024_blocking_confidence\032\017\n"
- + "\r"
+ + "\023blocking_confidence\030\004 \001(\01624.goog"
+ + "le.cloud.aiplatform.v1.Tool.PhishBlockThresholdB\003\340A\001H\000\210\001\001B\026\n"
+ + "\024_blocking_confidence\032^\n"
+ + "\020ParallelAiSearch\022\024\n"
+ + "\007api_key\030\001 \001(\tB\003\340A\001\0224\n"
+ + "\016custom_configs\030\003"
+ + " \001(\0132\027.google.protobuf.StructB\003\340A\001\032\017\n\r"
+ "CodeExecution\032\322\001\n"
+ "\013ComputerUse\022R\n"
- + "\013environment\030\001"
- + " \001(\01628.google.cloud.aiplatform.v1.Tool.ComputerUse.EnvironmentB\003\340A\002\022*\n"
+ + "\013environment\030\001 \001(\01628.google"
+ + ".cloud.aiplatform.v1.Tool.ComputerUse.EnvironmentB\003\340A\002\022*\n"
+ "\035excluded_predefined_functions\030\002 \003(\tB\003\340A\001\"C\n"
+ "\013Environment\022\033\n"
+ "\027ENVIRONMENT_UNSPECIFIED\020\000\022\027\n"
@@ -235,23 +244,24 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\014FunctionCall\022\021\n"
+ "\004name\030\001 \001(\tB\003\340A\001\022*\n"
+ "\004args\030\002 \001(\0132\027.google.protobuf.StructB\003\340A\001\022A\n"
- + "\014partial_args\030\004"
- + " \003(\0132&.google.cloud.aiplatform.v1.PartialArgB\003\340A\001\022\032\n\r"
+ + "\014partial_args\030\004 \003(\0132&.g"
+ + "oogle.cloud.aiplatform.v1.PartialArgB\003\340A\001\022\032\n\r"
+ "will_continue\030\005 \001(\010B\003\340A\001\"\325\001\n\n"
+ "PartialArg\0225\n\n"
+ "null_value\030\002"
+ " \001(\0162\032.google.protobuf.NullValueB\003\340A\001H\000\022\033\n"
+ "\014number_value\030\003 \001(\001B\003\340A\001H\000\022\033\n"
- + "\014string_value\030\004 \001(\tB\003\340A\001H\000\022\031\n\n"
+ + "\014string_value\030\004 \001(\tB\003\340A\001H\000\022\031\n"
+ + "\n"
+ "bool_value\030\005 \001(\010B\003\340A\001H\000\022\026\n"
+ "\tjson_path\030\001 \001(\tB\003\340A\002\022\032\n\r"
+ "will_continue\030\006 \001(\010B\003\340A\001B\007\n"
+ "\005delta\"\262\001\n"
+ "\024FunctionResponsePart\022G\n"
- + "\013inline_data\030\001 \001(\01320.google"
- + ".cloud.aiplatform.v1.FunctionResponseBlobH\000\022I\n"
- + "\tfile_data\030\002 \001(\01324.google.cloud.ai"
- + "platform.v1.FunctionResponseFileDataH\000B\006\n"
+ + "\013inline_data\030\001"
+ + " \001(\01320.google.cloud.aiplatform.v1.FunctionResponseBlobH\000\022I\n"
+ + "\tfile_data\030\002 \001"
+ + "(\01324.google.cloud.aiplatform.v1.FunctionResponseFileDataH\000B\006\n"
+ "\004data\"\\\n"
+ "\024FunctionResponseBlob\022\026\n"
+ "\tmime_type\030\001 \001(\tB\003\340A\002\022\021\n"
@@ -264,18 +274,18 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\020FunctionResponse\022\021\n"
+ "\004name\030\001 \001(\tB\003\340A\002\022.\n"
+ "\010response\030\002 \001(\0132\027.google.protobuf.StructB\003\340A\002\022D\n"
- + "\005parts\030\004 \003(\01320.google.cloud"
- + ".aiplatform.v1.FunctionResponsePartB\003\340A\001\"\241\001\n"
+ + "\005parts\030\004"
+ + " \003(\01320.google.cloud.aiplatform.v1.FunctionResponsePartB\003\340A\001\"\241\001\n"
+ "\016ExecutableCode\022J\n"
- + "\010language\030\001 \001(\01623."
- + "google.cloud.aiplatform.v1.ExecutableCode.LanguageB\003\340A\002\022\021\n"
+ + "\010language\030\001"
+ + " \001(\01623.google.cloud.aiplatform.v1.ExecutableCode.LanguageB\003\340A\002\022\021\n"
+ "\004code\030\002 \001(\tB\003\340A\002\"0\n"
+ "\010Language\022\030\n"
+ "\024LANGUAGE_UNSPECIFIED\020\000\022\n\n"
+ "\006PYTHON\020\001\"\340\001\n"
+ "\023CodeExecutionResult\022M\n"
- + "\007outcome\030\001"
- + " \001(\01627.google.cloud.aiplatform.v1.CodeExecutionResult.OutcomeB\003\340A\002\022\023\n"
+ + "\007outcome\030\001 \001(\01627.google.cloud"
+ + ".aiplatform.v1.CodeExecutionResult.OutcomeB\003\340A\002\022\023\n"
+ "\006output\030\002 \001(\tB\003\340A\001\"e\n"
+ "\007Outcome\022\027\n"
+ "\023OUTCOME_UNSPECIFIED\020\000\022\016\n\n"
@@ -285,18 +295,18 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\tRetrieval\022F\n"
+ "\020vertex_ai_search\030\002"
+ " \001(\0132*.google.cloud.aiplatform.v1.VertexAISearchH\000\022F\n"
- + "\020vertex_rag_store\030\004"
- + " \001(\0132*.google.cloud.aiplatform.v1.VertexRagStoreH\000\022\"\n"
+ + "\020vertex_rag_store\030\004 "
+ + "\001(\0132*.google.cloud.aiplatform.v1.VertexRagStoreH\000\022\"\n"
+ "\023disable_attribution\030\003 \001(\010B\005\030\001\340A\001B\010\n"
+ "\006source\"\252\003\n"
+ "\016VertexRagStore\022R\n\r"
- + "rag_resources\030\004 \003(\01326."
- + "google.cloud.aiplatform.v1.VertexRagStore.RagResourceB\003\340A\001\022$\n"
+ + "rag_resources\030\004 \003(\01326.google.cloud.aiplatf"
+ + "orm.v1.VertexRagStore.RagResourceB\003\340A\001\022$\n"
+ "\020similarity_top_k\030\002 \001(\005B\005\030\001\340A\001H\000\210\001\001\022-\n"
+ "\031vector_distance_threshold\030\003"
+ " \001(\001B\005\030\001\340A\001H\001\210\001\001\022Q\n"
- + "\024rag_retrieval_config\030\006"
- + " \001(\0132..google.cloud.aiplatform.v1.RagRetrievalConfigB\003\340A\001\032i\n"
+ + "\024rag_retrieval_config\030\006 \001(\0132..goog"
+ + "le.cloud.aiplatform.v1.RagRetrievalConfigB\003\340A\001\032i\n"
+ "\013RagResource\022?\n\n"
+ "rag_corpus\030\001 \001(\tB+\340A\001\372A%\n"
+ "#aiplatform.googleapis.com/RagCorpus\022\031\n"
@@ -308,37 +318,37 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\006engine\030\002 \001(\tB\003\340A\001\022\030\n"
+ "\013max_results\030\003 \001(\005B\003\340A\001\022\023\n"
+ "\006filter\030\004 \001(\tB\003\340A\001\022R\n"
- + "\020data_store_specs\030\005 \003("
- + "\01328.google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec\0328\n\r"
+ + "\020data_store_specs\030\005 \003(\01328.google.cloud.aip"
+ + "latform.v1.VertexAISearch.DataStoreSpec\0328\n\r"
+ "DataStoreSpec\022\022\n\n"
+ "data_store\030\001 \001(\t\022\023\n"
+ "\006filter\030\002 \001(\tB\003\340A\001\"m\n"
+ "\025GoogleSearchRetrieval\022T\n"
- + "\030dynamic_retrieval_config\030\002"
- + " \001(\01322.google.cloud.aiplatform.v1.DynamicRetrievalConfig\"(\n\n"
+ + "\030dynamic_retrieval_config\030\002 \001(\01322.g"
+ + "oogle.cloud.aiplatform.v1.DynamicRetrievalConfig\"(\n\n"
+ "GoogleMaps\022\032\n\r"
+ "enable_widget\030\001 \001(\010B\003\340A\001\"\250\001\n"
+ "\023EnterpriseWebSearch\022\034\n"
+ "\017exclude_domains\030\001 \003(\tB\003\340A\001\022[\n"
- + "\023blocking_confidence\030\002 \001(\01624.goog"
- + "le.cloud.aiplatform.v1.Tool.PhishBlockThresholdB\003\340A\001H\000\210\001\001B\026\n"
+ + "\023blocking_confidence\030\002"
+ + " \001(\01624.google.cloud.aiplatform.v1.Tool.PhishBlockThresholdB\003\340A\001H\000\210\001\001B\026\n"
+ "\024_blocking_confidence\"\312\001\n"
+ "\026DynamicRetrievalConfig\022E\n"
- + "\004mode\030\001 \001"
- + "(\01627.google.cloud.aiplatform.v1.DynamicRetrievalConfig.Mode\022#\n"
+ + "\004mode\030\001 \001(\01627.google.cloud.ai"
+ + "platform.v1.DynamicRetrievalConfig.Mode\022#\n"
+ "\021dynamic_threshold\030\002 \001(\002B\003\340A\001H\000\210\001\001\".\n"
+ "\004Mode\022\024\n"
+ "\020MODE_UNSPECIFIED\020\000\022\020\n"
+ "\014MODE_DYNAMIC\020\001B\024\n"
+ "\022_dynamic_threshold\"\261\001\n\n"
+ "ToolConfig\022W\n"
- + "\027function_calling_config\030\001"
- + " \001(\01321.google.cloud.aiplatform.v1.FunctionCallingConfigB\003\340A\001\022J\n"
- + "\020retrieval_config\030\002"
- + " \001(\0132+.google.cloud.aiplatform.v1.RetrievalConfigB\003\340A\001\"\204\002\n"
+ + "\027function_calling_config\030\001 \001(\01321.goo"
+ + "gle.cloud.aiplatform.v1.FunctionCallingConfigB\003\340A\001\022J\n"
+ + "\020retrieval_config\030\002 \001(\0132+.g"
+ + "oogle.cloud.aiplatform.v1.RetrievalConfigB\003\340A\001\"\204\002\n"
+ "\025FunctionCallingConfig\022I\n"
- + "\004mode\030\001 \001(\01626.google.clou"
- + "d.aiplatform.v1.FunctionCallingConfig.ModeB\003\340A\001\022#\n"
+ + "\004mode\030\001"
+ + " \001(\01626.google.cloud.aiplatform.v1.FunctionCallingConfig.ModeB\003\340A\001\022#\n"
+ "\026allowed_function_names\030\002 \003(\tB\003\340A\001\022+\n"
+ "\036stream_function_call_arguments\030\004 \001(\010B\003\340A\001\"N\n"
+ "\004Mode\022\024\n"
@@ -354,20 +364,20 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\016_language_code\"\252\005\n"
+ "\022RagRetrievalConfig\022\022\n"
+ "\005top_k\030\001 \001(\005B\003\340A\001\022J\n"
- + "\006filter\030\003 \001(\01325.google.cl"
- + "oud.aiplatform.v1.RagRetrievalConfig.FilterB\003\340A\001\022L\n"
- + "\007ranking\030\004 \001(\01326.google.cloud"
- + ".aiplatform.v1.RagRetrievalConfig.RankingB\003\340A\001\032\223\001\n"
+ + "\006filter\030\003"
+ + " \001(\01325.google.cloud.aiplatform.v1.RagRetrievalConfig.FilterB\003\340A\001\022L\n"
+ + "\007ranking\030\004"
+ + " \001(\01326.google.cloud.aiplatform.v1.RagRetrievalConfig.RankingB\003\340A\001\032\223\001\n"
+ "\006Filter\022(\n"
+ "\031vector_distance_threshold\030\003 \001(\001B\003\340A\001H\000\022*\n"
+ "\033vector_similarity_threshold\030\004 \001(\001B\003\340A\001H\000\022\034\n"
+ "\017metadata_filter\030\002 \001(\tB\003\340A\001B\025\n"
+ "\023vector_db_threshold\032\317\002\n"
+ "\007Ranking\022_\n"
- + "\014rank_service\030\001 \001(\0132B.google."
- + "cloud.aiplatform.v1.RagRetrievalConfig.Ranking.RankServiceB\003\340A\001H\000\022[\n\n"
- + "llm_ranker\030\003 \001(\0132@.google.cloud.aiplatform.v1.RagRe"
- + "trievalConfig.Ranking.LlmRankerB\003\340A\001H\000\032:\n"
+ + "\014rank_service\030\001 \001(\0132B.google.cloud.aiplatform.v1."
+ + "RagRetrievalConfig.Ranking.RankServiceB\003\340A\001H\000\022[\n\n"
+ + "llm_ranker\030\003 \001(\0132@.google.cloud"
+ + ".aiplatform.v1.RagRetrievalConfig.Ranking.LlmRankerB\003\340A\001H\000\032:\n"
+ "\013RankService\022\034\n\n"
+ "model_name\030\001 \001(\tB\003\340A\001H\000\210\001\001B\r\n"
+ "\013_model_name\0328\n"
@@ -375,10 +385,11 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "model_name\030\001 \001(\tB\003\340A\001H\000\210\001\001B\r\n"
+ "\013_model_nameB\020\n"
+ "\016ranking_configB\307\001\n"
- + "\036com.google.cloud.aiplatform.v1B\tToolProtoP\001Z>cloud.google.com"
- + "/go/aiplatform/apiv1/aiplatformpb;aiplat"
- + "formpb\252\002\032Google.Cloud.AIPlatform.V1\312\002\032Go"
- + "ogle\\Cloud\\AIPlatform\\V1\352\002\035Google::Cloud::AIPlatform::V1b\006proto3"
+ + "\036com.google.cloud.aiplatform.v1B\tToolProto"
+ + "P\001Z>cloud.google.com/go/aiplatform/apiv1"
+ + "/aiplatformpb;aiplatformpb\252\002\032Google.Clou"
+ + "d.AIPlatform.V1\312\002\032Google\\Cloud\\AIPlatfor"
+ + "m\\V1\352\002\035Google::Cloud::AIPlatform::V1b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
@@ -401,6 +412,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
"GoogleSearchRetrieval",
"GoogleMaps",
"EnterpriseWebSearch",
+ "ParallelAiSearch",
"CodeExecution",
"UrlContext",
"ComputerUse",
@@ -413,14 +425,22 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
new java.lang.String[] {
"ExcludeDomains", "BlockingConfidence",
});
- internal_static_google_cloud_aiplatform_v1_Tool_CodeExecution_descriptor =
+ internal_static_google_cloud_aiplatform_v1_Tool_ParallelAiSearch_descriptor =
internal_static_google_cloud_aiplatform_v1_Tool_descriptor.getNestedType(1);
+ internal_static_google_cloud_aiplatform_v1_Tool_ParallelAiSearch_fieldAccessorTable =
+ new com.google.protobuf.GeneratedMessage.FieldAccessorTable(
+ internal_static_google_cloud_aiplatform_v1_Tool_ParallelAiSearch_descriptor,
+ new java.lang.String[] {
+ "ApiKey", "CustomConfigs",
+ });
+ internal_static_google_cloud_aiplatform_v1_Tool_CodeExecution_descriptor =
+ internal_static_google_cloud_aiplatform_v1_Tool_descriptor.getNestedType(2);
internal_static_google_cloud_aiplatform_v1_Tool_CodeExecution_fieldAccessorTable =
new com.google.protobuf.GeneratedMessage.FieldAccessorTable(
internal_static_google_cloud_aiplatform_v1_Tool_CodeExecution_descriptor,
new java.lang.String[] {});
internal_static_google_cloud_aiplatform_v1_Tool_ComputerUse_descriptor =
- internal_static_google_cloud_aiplatform_v1_Tool_descriptor.getNestedType(2);
+ internal_static_google_cloud_aiplatform_v1_Tool_descriptor.getNestedType(3);
internal_static_google_cloud_aiplatform_v1_Tool_ComputerUse_fieldAccessorTable =
new com.google.protobuf.GeneratedMessage.FieldAccessorTable(
internal_static_google_cloud_aiplatform_v1_Tool_ComputerUse_descriptor,
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/VertexRagStore.java b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/VertexRagStore.java
index df7fcf5aee3d..a42b308cb2b0 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/VertexRagStore.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/VertexRagStore.java
@@ -1195,7 +1195,7 @@ public com.google.cloud.aiplatform.v1.VertexRagStore.RagResource getRagResources
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
- * google/cloud/aiplatform/v1/tool.proto;l=457
+ * google/cloud/aiplatform/v1/tool.proto;l=494
* @return Whether the similarityTopK field is set.
*/
@java.lang.Override
@@ -1216,7 +1216,7 @@ public boolean hasSimilarityTopK() {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
- * google/cloud/aiplatform/v1/tool.proto;l=457
+ * google/cloud/aiplatform/v1/tool.proto;l=494
* @return The similarityTopK.
*/
@java.lang.Override
@@ -1241,7 +1241,7 @@ public int getSimilarityTopK() {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated.
- * See google/cloud/aiplatform/v1/tool.proto;l=462
+ * See google/cloud/aiplatform/v1/tool.proto;l=499
* @return Whether the vectorDistanceThreshold field is set.
*/
@java.lang.Override
@@ -1263,7 +1263,7 @@ public boolean hasVectorDistanceThreshold() {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated.
- * See google/cloud/aiplatform/v1/tool.proto;l=462
+ * See google/cloud/aiplatform/v1/tool.proto;l=499
* @return The vectorDistanceThreshold.
*/
@java.lang.Override
@@ -2285,7 +2285,7 @@ public com.google.cloud.aiplatform.v1.VertexRagStore.RagResource.Builder addRagR
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
- * google/cloud/aiplatform/v1/tool.proto;l=457
+ * google/cloud/aiplatform/v1/tool.proto;l=494
* @return Whether the similarityTopK field is set.
*/
@java.lang.Override
@@ -2306,7 +2306,7 @@ public boolean hasSimilarityTopK() {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
- * google/cloud/aiplatform/v1/tool.proto;l=457
+ * google/cloud/aiplatform/v1/tool.proto;l=494
* @return The similarityTopK.
*/
@java.lang.Override
@@ -2327,7 +2327,7 @@ public int getSimilarityTopK() {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
- * google/cloud/aiplatform/v1/tool.proto;l=457
+ * google/cloud/aiplatform/v1/tool.proto;l=494
* @param value The similarityTopK to set.
* @return This builder for chaining.
*/
@@ -2352,7 +2352,7 @@ public Builder setSimilarityTopK(int value) {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
- * google/cloud/aiplatform/v1/tool.proto;l=457
+ * google/cloud/aiplatform/v1/tool.proto;l=494
* @return This builder for chaining.
*/
@java.lang.Deprecated
@@ -2378,7 +2378,7 @@ public Builder clearSimilarityTopK() {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is
- * deprecated. See google/cloud/aiplatform/v1/tool.proto;l=462
+ * deprecated. See google/cloud/aiplatform/v1/tool.proto;l=499
* @return Whether the vectorDistanceThreshold field is set.
*/
@java.lang.Override
@@ -2400,7 +2400,7 @@ public boolean hasVectorDistanceThreshold() {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is
- * deprecated. See google/cloud/aiplatform/v1/tool.proto;l=462
+ * deprecated. See google/cloud/aiplatform/v1/tool.proto;l=499
* @return The vectorDistanceThreshold.
*/
@java.lang.Override
@@ -2422,7 +2422,7 @@ public double getVectorDistanceThreshold() {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is
- * deprecated. See google/cloud/aiplatform/v1/tool.proto;l=462
+ * deprecated. See google/cloud/aiplatform/v1/tool.proto;l=499
* @param value The vectorDistanceThreshold to set.
* @return This builder for chaining.
*/
@@ -2448,7 +2448,7 @@ public Builder setVectorDistanceThreshold(double value) {
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is
- * deprecated. See google/cloud/aiplatform/v1/tool.proto;l=462
+ * deprecated. See google/cloud/aiplatform/v1/tool.proto;l=499
* @return This builder for chaining.
*/
@java.lang.Deprecated
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/VertexRagStoreOrBuilder.java b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/VertexRagStoreOrBuilder.java
index 5cf338129e0d..b3ad8230d82e 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/VertexRagStoreOrBuilder.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/java/com/google/cloud/aiplatform/v1/VertexRagStoreOrBuilder.java
@@ -120,7 +120,7 @@ com.google.cloud.aiplatform.v1.VertexRagStore.RagResourceOrBuilder getRagResourc
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
- * google/cloud/aiplatform/v1/tool.proto;l=457
+ * google/cloud/aiplatform/v1/tool.proto;l=494
* @return Whether the similarityTopK field is set.
*/
@java.lang.Deprecated
@@ -138,7 +138,7 @@ com.google.cloud.aiplatform.v1.VertexRagStore.RagResourceOrBuilder getRagResourc
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
- * google/cloud/aiplatform/v1/tool.proto;l=457
+ * google/cloud/aiplatform/v1/tool.proto;l=494
* @return The similarityTopK.
*/
@java.lang.Deprecated
@@ -157,7 +157,7 @@ com.google.cloud.aiplatform.v1.VertexRagStore.RagResourceOrBuilder getRagResourc
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated.
- * See google/cloud/aiplatform/v1/tool.proto;l=462
+ * See google/cloud/aiplatform/v1/tool.proto;l=499
* @return Whether the vectorDistanceThreshold field is set.
*/
@java.lang.Deprecated
@@ -176,7 +176,7 @@ com.google.cloud.aiplatform.v1.VertexRagStore.RagResourceOrBuilder getRagResourc
*
*
* @deprecated google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated.
- * See google/cloud/aiplatform/v1/tool.proto;l=462
+ * See google/cloud/aiplatform/v1/tool.proto;l=499
* @return The vectorDistanceThreshold.
*/
@java.lang.Deprecated
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/proto/google/cloud/aiplatform/v1/tool.proto b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/proto/google/cloud/aiplatform/v1/tool.proto
index 96bda732c143..a5d730aefda1 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/proto/google/cloud/aiplatform/v1/tool.proto
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1/src/main/proto/google/cloud/aiplatform/v1/tool.proto
@@ -79,6 +79,37 @@ message Tool {
[(google.api.field_behavior) = OPTIONAL];
}
+ // ParallelAiSearch tool type.
+ // A tool that uses the Parallel.ai search engine for grounding.
+ message ParallelAiSearch {
+ // Optional. The API key for ParallelAiSearch.
+ // If an API key is not provided, the system will attempt to verify access
+ // by checking for an active Parallel.ai subscription through the Google
+ // Cloud Marketplace.
+ // See https://docs.parallel.ai/search/search-quickstart for more details.
+ string api_key = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Custom configs for ParallelAiSearch.
+ // This field can be used to pass any parameter from the Parallel.ai
+ // Search API.
+ // See the Parallel.ai documentation for the full list of available
+ // parameters and their usage:
+ // https://docs.parallel.ai/api-reference/search-beta/search
+ // Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ // `fetch_policy` can be set via this field. For example:
+ // {
+ // "source_policy": {
+ // "include_domains": ["google.com", "wikipedia.org"],
+ // "exclude_domains": ["example.com"]
+ // },
+ // "fetch_policy": {
+ // "max_age_seconds": 3600
+ // }
+ // }
+ google.protobuf.Struct custom_configs = 3
+ [(google.api.field_behavior) = OPTIONAL];
+ }
+
// Tool that executes code generated by the model, and automatically returns
// the result to the model.
//
@@ -146,6 +177,12 @@ message Tool {
EnterpriseWebSearch enterprise_web_search = 6
[(google.api.field_behavior) = OPTIONAL];
+ // Optional. If specified, Vertex AI will use Parallel.ai to search for
+ // information to answer user queries. The search results will be grounded on
+ // Parallel.ai and presented to the model for response generation
+ ParallelAiSearch parallel_ai_search = 13
+ [(google.api.field_behavior) = OPTIONAL];
+
// Optional. CodeExecution tool type.
// Enables the model to execute code as part of generation.
CodeExecution code_execution = 4 [(google.api.field_behavior) = OPTIONAL];
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/EvaluationRubricProto.java b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/EvaluationRubricProto.java
index fc2d63b20c4f..7ca6978dc98d 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/EvaluationRubricProto.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/EvaluationRubricProto.java
@@ -101,11 +101,12 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ " \001(\0132\'.google.cloud.aiplatform.v1beta1.Rubric\022\017\n"
+ "\007verdict\030\002 \001(\010\022\026\n"
+ "\treasoning\030\003 \001(\tH\000\210\001\001B\014\n\n"
- + "_reasoningB\247\001\n"
- + "#com.google.cloud.aiplatform.v1b"
- + "eta1B\025EvaluationRubricProtoP\001\252\002\037Google.C"
- + "loud.AIPlatform.V1Beta1\312\002\037Google\\Cloud\\A"
- + "IPlatform\\V1beta1\352\002\"Google::Cloud::AIPlatform::V1beta1b\006proto3"
+ + "_reasoningB\354\001\n"
+ + "#com.google.cloud.aiplatform.v1beta1B\025EvaluationRubricProtoP\001ZCcloud.goo"
+ + "gle.com/go/aiplatform/apiv1beta1/aiplatf"
+ + "ormpb;aiplatformpb\252\002\037Google.Cloud.AIPlat"
+ + "form.V1Beta1\312\002\037Google\\Cloud\\AIPlatform\\V"
+ + "1beta1\352\002\"Google::Cloud::AIPlatform::V1beta1b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/Retrieval.java b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/Retrieval.java
index a998d8af8e0e..c359c3281c7a 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/Retrieval.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/Retrieval.java
@@ -244,7 +244,7 @@ public com.google.cloud.aiplatform.v1beta1.VertexRagStoreOrBuilder getVertexRagS
*
*
* @deprecated google.cloud.aiplatform.v1beta1.Retrieval.disable_attribution is deprecated. See
- * google/cloud/aiplatform/v1beta1/tool.proto;l=473
+ * google/cloud/aiplatform/v1beta1/tool.proto;l=510
* @return The disableAttribution.
*/
@java.lang.Override
@@ -1124,7 +1124,7 @@ public com.google.cloud.aiplatform.v1beta1.VertexRagStore.Builder getVertexRagSt
*
*
* @deprecated google.cloud.aiplatform.v1beta1.Retrieval.disable_attribution is deprecated. See
- * google/cloud/aiplatform/v1beta1/tool.proto;l=473
+ * google/cloud/aiplatform/v1beta1/tool.proto;l=510
* @return The disableAttribution.
*/
@java.lang.Override
@@ -1145,7 +1145,7 @@ public boolean getDisableAttribution() {
*
*
* @deprecated google.cloud.aiplatform.v1beta1.Retrieval.disable_attribution is deprecated. See
- * google/cloud/aiplatform/v1beta1/tool.proto;l=473
+ * google/cloud/aiplatform/v1beta1/tool.proto;l=510
* @param value The disableAttribution to set.
* @return This builder for chaining.
*/
@@ -1170,7 +1170,7 @@ public Builder setDisableAttribution(boolean value) {
*
*
* @deprecated google.cloud.aiplatform.v1beta1.Retrieval.disable_attribution is deprecated. See
- * google/cloud/aiplatform/v1beta1/tool.proto;l=473
+ * google/cloud/aiplatform/v1beta1/tool.proto;l=510
* @return This builder for chaining.
*/
@java.lang.Deprecated
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/RetrievalOrBuilder.java b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/RetrievalOrBuilder.java
index 9c8e8c0dd680..dd40e518c0b3 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/RetrievalOrBuilder.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/RetrievalOrBuilder.java
@@ -115,7 +115,7 @@ public interface RetrievalOrBuilder
*
*
* @deprecated google.cloud.aiplatform.v1beta1.Retrieval.disable_attribution is deprecated. See
- * google/cloud/aiplatform/v1beta1/tool.proto;l=473
+ * google/cloud/aiplatform/v1beta1/tool.proto;l=510
* @return The disableAttribution.
*/
@java.lang.Deprecated
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/Tool.java b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/Tool.java
index 49b2e8f7c939..8c34263b3d2c 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/Tool.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/Tool.java
@@ -1394,6 +1394,1237 @@ public com.google.cloud.aiplatform.v1beta1.Tool.GoogleSearch getDefaultInstanceF
}
}
+ public interface ParallelAiSearchOrBuilder
+ extends
+ // @@protoc_insertion_point(interface_extends:google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch)
+ com.google.protobuf.MessageOrBuilder {
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The apiKey.
+ */
+ java.lang.String getApiKey();
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The bytes for apiKey.
+ */
+ com.google.protobuf.ByteString getApiKeyBytes();
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the customConfigs field is set.
+ */
+ boolean hasCustomConfigs();
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The customConfigs.
+ */
+ com.google.protobuf.Struct getCustomConfigs();
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ com.google.protobuf.StructOrBuilder getCustomConfigsOrBuilder();
+ }
+
+ /**
+ *
+ *
+ * + * ParallelAiSearch tool type. + * A tool that uses the Parallel.ai search engine for grounding. + *+ * + * Protobuf type {@code google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch} + */ + public static final class ParallelAiSearch extends com.google.protobuf.GeneratedMessage + implements + // @@protoc_insertion_point(message_implements:google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch) + ParallelAiSearchOrBuilder { + private static final long serialVersionUID = 0L; + + static { + com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion( + com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC, + /* major= */ 4, + /* minor= */ 33, + /* patch= */ 2, + /* suffix= */ "", + "ParallelAiSearch"); + } + + // Use ParallelAiSearch.newBuilder() to construct. + private ParallelAiSearch(com.google.protobuf.GeneratedMessage.Builder builder) { + super(builder); + } + + private ParallelAiSearch() { + apiKey_ = ""; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.cloud.aiplatform.v1beta1.ToolProto + .internal_static_google_cloud_aiplatform_v1beta1_Tool_ParallelAiSearch_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.cloud.aiplatform.v1beta1.ToolProto + .internal_static_google_cloud_aiplatform_v1beta1_Tool_ParallelAiSearch_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.class, + com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.Builder.class); + } + + private int bitField0_; + public static final int API_KEY_FIELD_NUMBER = 1; + + @SuppressWarnings("serial") + private volatile java.lang.Object apiKey_ = ""; + + /** + * + * + *
+ * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The apiKey.
+ */
+ @java.lang.Override
+ public java.lang.String getApiKey() {
+ java.lang.Object ref = apiKey_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ apiKey_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The bytes for apiKey.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getApiKeyBytes() {
+ java.lang.Object ref = apiKey_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ apiKey_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int CUSTOM_CONFIGS_FIELD_NUMBER = 3;
+ private com.google.protobuf.Struct customConfigs_;
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the customConfigs field is set.
+ */
+ @java.lang.Override
+ public boolean hasCustomConfigs() {
+ return ((bitField0_ & 0x00000001) != 0);
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The customConfigs.
+ */
+ @java.lang.Override
+ public com.google.protobuf.Struct getCustomConfigs() {
+ return customConfigs_ == null
+ ? com.google.protobuf.Struct.getDefaultInstance()
+ : customConfigs_;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ @java.lang.Override
+ public com.google.protobuf.StructOrBuilder getCustomConfigsOrBuilder() {
+ return customConfigs_ == null
+ ? com.google.protobuf.Struct.getDefaultInstance()
+ : customConfigs_;
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(apiKey_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 1, apiKey_);
+ }
+ if (((bitField0_ & 0x00000001) != 0)) {
+ output.writeMessage(3, getCustomConfigs());
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(apiKey_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(1, apiKey_);
+ }
+ if (((bitField0_ & 0x00000001) != 0)) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(3, getCustomConfigs());
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch)) {
+ return super.equals(obj);
+ }
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch other =
+ (com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch) obj;
+
+ if (!getApiKey().equals(other.getApiKey())) return false;
+ if (hasCustomConfigs() != other.hasCustomConfigs()) return false;
+ if (hasCustomConfigs()) {
+ if (!getCustomConfigs().equals(other.getCustomConfigs())) return false;
+ }
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ hash = (37 * hash) + API_KEY_FIELD_NUMBER;
+ hash = (53 * hash) + getApiKey().hashCode();
+ if (hasCustomConfigs()) {
+ hash = (37 * hash) + CUSTOM_CONFIGS_FIELD_NUMBER;
+ hash = (53 * hash) + getCustomConfigs().hashCode();
+ }
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(byte[] data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+
+ /**
+ *
+ *
+ * + * ParallelAiSearch tool type. + * A tool that uses the Parallel.ai search engine for grounding. + *+ * + * Protobuf type {@code google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessage.Builder
+ * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The apiKey.
+ */
+ public java.lang.String getApiKey() {
+ java.lang.Object ref = apiKey_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ apiKey_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The bytes for apiKey.
+ */
+ public com.google.protobuf.ByteString getApiKeyBytes() {
+ java.lang.Object ref = apiKey_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ apiKey_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @param value The apiKey to set.
+ * @return This builder for chaining.
+ */
+ public Builder setApiKey(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ apiKey_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearApiKey() {
+ apiKey_ = getDefaultInstance().getApiKey();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. The API key for ParallelAiSearch. + * If an API key is not provided, the system will attempt to verify access + * by checking for an active Parallel.ai subscription through the Google + * Cloud Marketplace. + * See https://docs.parallel.ai/search/search-quickstart for more details. + *+ * + *
string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @param value The bytes for apiKey to set.
+ * @return This builder for chaining.
+ */
+ public Builder setApiKeyBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ apiKey_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private com.google.protobuf.Struct customConfigs_;
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.protobuf.Struct,
+ com.google.protobuf.Struct.Builder,
+ com.google.protobuf.StructOrBuilder>
+ customConfigsBuilder_;
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the customConfigs field is set.
+ */
+ public boolean hasCustomConfigs() {
+ return ((bitField0_ & 0x00000002) != 0);
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The customConfigs.
+ */
+ public com.google.protobuf.Struct getCustomConfigs() {
+ if (customConfigsBuilder_ == null) {
+ return customConfigs_ == null
+ ? com.google.protobuf.Struct.getDefaultInstance()
+ : customConfigs_;
+ } else {
+ return customConfigsBuilder_.getMessage();
+ }
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder setCustomConfigs(com.google.protobuf.Struct value) {
+ if (customConfigsBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ customConfigs_ = value;
+ } else {
+ customConfigsBuilder_.setMessage(value);
+ }
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder setCustomConfigs(com.google.protobuf.Struct.Builder builderForValue) {
+ if (customConfigsBuilder_ == null) {
+ customConfigs_ = builderForValue.build();
+ } else {
+ customConfigsBuilder_.setMessage(builderForValue.build());
+ }
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder mergeCustomConfigs(com.google.protobuf.Struct value) {
+ if (customConfigsBuilder_ == null) {
+ if (((bitField0_ & 0x00000002) != 0)
+ && customConfigs_ != null
+ && customConfigs_ != com.google.protobuf.Struct.getDefaultInstance()) {
+ getCustomConfigsBuilder().mergeFrom(value);
+ } else {
+ customConfigs_ = value;
+ }
+ } else {
+ customConfigsBuilder_.mergeFrom(value);
+ }
+ if (customConfigs_ != null) {
+ bitField0_ |= 0x00000002;
+ onChanged();
+ }
+ return this;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder clearCustomConfigs() {
+ bitField0_ = (bitField0_ & ~0x00000002);
+ customConfigs_ = null;
+ if (customConfigsBuilder_ != null) {
+ customConfigsBuilder_.dispose();
+ customConfigsBuilder_ = null;
+ }
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public com.google.protobuf.Struct.Builder getCustomConfigsBuilder() {
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return internalGetCustomConfigsFieldBuilder().getBuilder();
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public com.google.protobuf.StructOrBuilder getCustomConfigsOrBuilder() {
+ if (customConfigsBuilder_ != null) {
+ return customConfigsBuilder_.getMessageOrBuilder();
+ } else {
+ return customConfigs_ == null
+ ? com.google.protobuf.Struct.getDefaultInstance()
+ : customConfigs_;
+ }
+ }
+
+ /**
+ *
+ *
+ *
+ * Optional. Custom configs for ParallelAiSearch.
+ * This field can be used to pass any parameter from the Parallel.ai
+ * Search API.
+ * See the Parallel.ai documentation for the full list of available
+ * parameters and their usage:
+ * https://docs.parallel.ai/api-reference/search-beta/search
+ * Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
+ * `fetch_policy` can be set via this field. For example:
+ * {
+ * "source_policy": {
+ * "include_domains": ["google.com", "wikipedia.org"],
+ * "exclude_domains": ["example.com"]
+ * },
+ * "fetch_policy": {
+ * "max_age_seconds": 3600
+ * }
+ * }
+ *
+ *
+ * .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.protobuf.Struct,
+ com.google.protobuf.Struct.Builder,
+ com.google.protobuf.StructOrBuilder>
+ internalGetCustomConfigsFieldBuilder() {
+ if (customConfigsBuilder_ == null) {
+ customConfigsBuilder_ =
+ new com.google.protobuf.SingleFieldBuilder<
+ com.google.protobuf.Struct,
+ com.google.protobuf.Struct.Builder,
+ com.google.protobuf.StructOrBuilder>(
+ getCustomConfigs(), getParentForChildren(), isClean());
+ customConfigs_ = null;
+ }
+ return customConfigsBuilder_;
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch)
+ private static final com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch();
+ }
+
+ public static com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser+ * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the parallelAiSearch field is set.
+ */
+ @java.lang.Override
+ public boolean hasParallelAiSearch() {
+ return ((bitField0_ & 0x00000020) != 0);
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The parallelAiSearch.
+ */
+ @java.lang.Override
+ public com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch getParallelAiSearch() {
+ return parallelAiSearch_ == null
+ ? com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.getDefaultInstance()
+ : parallelAiSearch_;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ @java.lang.Override
+ public com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearchOrBuilder
+ getParallelAiSearchOrBuilder() {
+ return parallelAiSearch_ == null
+ ? com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.getDefaultInstance()
+ : parallelAiSearch_;
+ }
+
public static final int CODE_EXECUTION_FIELD_NUMBER = 4;
private com.google.cloud.aiplatform.v1beta1.Tool.CodeExecution codeExecution_;
@@ -3476,7 +4773,7 @@ public com.google.cloud.aiplatform.v1beta1.EnterpriseWebSearch getEnterpriseWebS
*/
@java.lang.Override
public boolean hasCodeExecution() {
- return ((bitField0_ & 0x00000020) != 0);
+ return ((bitField0_ & 0x00000040) != 0);
}
/**
@@ -3538,7 +4835,7 @@ public com.google.cloud.aiplatform.v1beta1.Tool.CodeExecution getCodeExecution()
*/
@java.lang.Override
public boolean hasUrlContext() {
- return ((bitField0_ & 0x00000040) != 0);
+ return ((bitField0_ & 0x00000080) != 0);
}
/**
@@ -3599,7 +4896,7 @@ public com.google.cloud.aiplatform.v1beta1.UrlContextOrBuilder getUrlContextOrBu
*/
@java.lang.Override
public boolean hasComputerUse() {
- return ((bitField0_ & 0x00000080) != 0);
+ return ((bitField0_ & 0x00000100) != 0);
}
/**
@@ -3667,7 +4964,7 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (((bitField0_ & 0x00000004) != 0)) {
output.writeMessage(3, getGoogleSearchRetrieval());
}
- if (((bitField0_ & 0x00000020) != 0)) {
+ if (((bitField0_ & 0x00000040) != 0)) {
output.writeMessage(4, getCodeExecution());
}
if (((bitField0_ & 0x00000008) != 0)) {
@@ -3679,12 +4976,15 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (((bitField0_ & 0x00000002) != 0)) {
output.writeMessage(7, getGoogleSearch());
}
- if (((bitField0_ & 0x00000040) != 0)) {
+ if (((bitField0_ & 0x00000080) != 0)) {
output.writeMessage(10, getUrlContext());
}
- if (((bitField0_ & 0x00000080) != 0)) {
+ if (((bitField0_ & 0x00000100) != 0)) {
output.writeMessage(11, getComputerUse());
}
+ if (((bitField0_ & 0x00000020) != 0)) {
+ output.writeMessage(13, getParallelAiSearch());
+ }
getUnknownFields().writeTo(output);
}
@@ -3705,7 +5005,7 @@ public int getSerializedSize() {
size +=
com.google.protobuf.CodedOutputStream.computeMessageSize(3, getGoogleSearchRetrieval());
}
- if (((bitField0_ & 0x00000020) != 0)) {
+ if (((bitField0_ & 0x00000040) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, getCodeExecution());
}
if (((bitField0_ & 0x00000008) != 0)) {
@@ -3717,12 +5017,15 @@ public int getSerializedSize() {
if (((bitField0_ & 0x00000002) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(7, getGoogleSearch());
}
- if (((bitField0_ & 0x00000040) != 0)) {
+ if (((bitField0_ & 0x00000080) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(10, getUrlContext());
}
- if (((bitField0_ & 0x00000080) != 0)) {
+ if (((bitField0_ & 0x00000100) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(11, getComputerUse());
}
+ if (((bitField0_ & 0x00000020) != 0)) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(13, getParallelAiSearch());
+ }
size += getUnknownFields().getSerializedSize();
memoizedSize = size;
return size;
@@ -3759,6 +5062,10 @@ public boolean equals(final java.lang.Object obj) {
if (hasEnterpriseWebSearch()) {
if (!getEnterpriseWebSearch().equals(other.getEnterpriseWebSearch())) return false;
}
+ if (hasParallelAiSearch() != other.hasParallelAiSearch()) return false;
+ if (hasParallelAiSearch()) {
+ if (!getParallelAiSearch().equals(other.getParallelAiSearch())) return false;
+ }
if (hasCodeExecution() != other.hasCodeExecution()) return false;
if (hasCodeExecution()) {
if (!getCodeExecution().equals(other.getCodeExecution())) return false;
@@ -3806,6 +5113,10 @@ public int hashCode() {
hash = (37 * hash) + ENTERPRISE_WEB_SEARCH_FIELD_NUMBER;
hash = (53 * hash) + getEnterpriseWebSearch().hashCode();
}
+ if (hasParallelAiSearch()) {
+ hash = (37 * hash) + PARALLEL_AI_SEARCH_FIELD_NUMBER;
+ hash = (53 * hash) + getParallelAiSearch().hashCode();
+ }
if (hasCodeExecution()) {
hash = (37 * hash) + CODE_EXECUTION_FIELD_NUMBER;
hash = (53 * hash) + getCodeExecution().hashCode();
@@ -3971,6 +5282,7 @@ private void maybeForceBuilderInitialization() {
internalGetGoogleSearchRetrievalFieldBuilder();
internalGetGoogleMapsFieldBuilder();
internalGetEnterpriseWebSearchFieldBuilder();
+ internalGetParallelAiSearchFieldBuilder();
internalGetCodeExecutionFieldBuilder();
internalGetUrlContextFieldBuilder();
internalGetComputerUseFieldBuilder();
@@ -4013,6 +5325,11 @@ public Builder clear() {
enterpriseWebSearchBuilder_.dispose();
enterpriseWebSearchBuilder_ = null;
}
+ parallelAiSearch_ = null;
+ if (parallelAiSearchBuilder_ != null) {
+ parallelAiSearchBuilder_.dispose();
+ parallelAiSearchBuilder_ = null;
+ }
codeExecution_ = null;
if (codeExecutionBuilder_ != null) {
codeExecutionBuilder_.dispose();
@@ -4106,18 +5423,23 @@ private void buildPartial0(com.google.cloud.aiplatform.v1beta1.Tool result) {
to_bitField0_ |= 0x00000010;
}
if (((from_bitField0_ & 0x00000040) != 0)) {
- result.codeExecution_ =
- codeExecutionBuilder_ == null ? codeExecution_ : codeExecutionBuilder_.build();
+ result.parallelAiSearch_ =
+ parallelAiSearchBuilder_ == null ? parallelAiSearch_ : parallelAiSearchBuilder_.build();
to_bitField0_ |= 0x00000020;
}
if (((from_bitField0_ & 0x00000080) != 0)) {
- result.urlContext_ = urlContextBuilder_ == null ? urlContext_ : urlContextBuilder_.build();
+ result.codeExecution_ =
+ codeExecutionBuilder_ == null ? codeExecution_ : codeExecutionBuilder_.build();
to_bitField0_ |= 0x00000040;
}
if (((from_bitField0_ & 0x00000100) != 0)) {
+ result.urlContext_ = urlContextBuilder_ == null ? urlContext_ : urlContextBuilder_.build();
+ to_bitField0_ |= 0x00000080;
+ }
+ if (((from_bitField0_ & 0x00000200) != 0)) {
result.computerUse_ =
computerUseBuilder_ == null ? computerUse_ : computerUseBuilder_.build();
- to_bitField0_ |= 0x00000080;
+ to_bitField0_ |= 0x00000100;
}
result.bitField0_ |= to_bitField0_;
}
@@ -4176,6 +5498,9 @@ public Builder mergeFrom(com.google.cloud.aiplatform.v1beta1.Tool other) {
if (other.hasEnterpriseWebSearch()) {
mergeEnterpriseWebSearch(other.getEnterpriseWebSearch());
}
+ if (other.hasParallelAiSearch()) {
+ mergeParallelAiSearch(other.getParallelAiSearch());
+ }
if (other.hasCodeExecution()) {
mergeCodeExecution(other.getCodeExecution());
}
@@ -4243,7 +5568,7 @@ public Builder mergeFrom(
{
input.readMessage(
internalGetCodeExecutionFieldBuilder().getBuilder(), extensionRegistry);
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
break;
} // case 34
case 42:
@@ -4271,16 +5596,23 @@ public Builder mergeFrom(
{
input.readMessage(
internalGetUrlContextFieldBuilder().getBuilder(), extensionRegistry);
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
break;
} // case 82
case 90:
{
input.readMessage(
internalGetComputerUseFieldBuilder().getBuilder(), extensionRegistry);
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
break;
} // case 90
+ case 106:
+ {
+ input.readMessage(
+ internalGetParallelAiSearchFieldBuilder().getBuilder(), extensionRegistry);
+ bitField0_ |= 0x00000040;
+ break;
+ } // case 106
default:
{
if (!super.parseUnknownField(input, extensionRegistry, tag)) {
@@ -6024,6 +7356,242 @@ public Builder clearEnterpriseWebSearch() {
return enterpriseWebSearchBuilder_;
}
+ private com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallelAiSearch_;
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch,
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.Builder,
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearchOrBuilder>
+ parallelAiSearchBuilder_;
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the parallelAiSearch field is set.
+ */
+ public boolean hasParallelAiSearch() {
+ return ((bitField0_ & 0x00000040) != 0);
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The parallelAiSearch.
+ */
+ public com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch getParallelAiSearch() {
+ if (parallelAiSearchBuilder_ == null) {
+ return parallelAiSearch_ == null
+ ? com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.getDefaultInstance()
+ : parallelAiSearch_;
+ } else {
+ return parallelAiSearchBuilder_.getMessage();
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder setParallelAiSearch(
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch value) {
+ if (parallelAiSearchBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ parallelAiSearch_ = value;
+ } else {
+ parallelAiSearchBuilder_.setMessage(value);
+ }
+ bitField0_ |= 0x00000040;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder setParallelAiSearch(
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.Builder builderForValue) {
+ if (parallelAiSearchBuilder_ == null) {
+ parallelAiSearch_ = builderForValue.build();
+ } else {
+ parallelAiSearchBuilder_.setMessage(builderForValue.build());
+ }
+ bitField0_ |= 0x00000040;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder mergeParallelAiSearch(
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch value) {
+ if (parallelAiSearchBuilder_ == null) {
+ if (((bitField0_ & 0x00000040) != 0)
+ && parallelAiSearch_ != null
+ && parallelAiSearch_
+ != com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.getDefaultInstance()) {
+ getParallelAiSearchBuilder().mergeFrom(value);
+ } else {
+ parallelAiSearch_ = value;
+ }
+ } else {
+ parallelAiSearchBuilder_.mergeFrom(value);
+ }
+ if (parallelAiSearch_ != null) {
+ bitField0_ |= 0x00000040;
+ onChanged();
+ }
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public Builder clearParallelAiSearch() {
+ bitField0_ = (bitField0_ & ~0x00000040);
+ parallelAiSearch_ = null;
+ if (parallelAiSearchBuilder_ != null) {
+ parallelAiSearchBuilder_.dispose();
+ parallelAiSearchBuilder_ = null;
+ }
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.Builder
+ getParallelAiSearchBuilder() {
+ bitField0_ |= 0x00000040;
+ onChanged();
+ return internalGetParallelAiSearchFieldBuilder().getBuilder();
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ public com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearchOrBuilder
+ getParallelAiSearchOrBuilder() {
+ if (parallelAiSearchBuilder_ != null) {
+ return parallelAiSearchBuilder_.getMessageOrBuilder();
+ } else {
+ return parallelAiSearch_ == null
+ ? com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.getDefaultInstance()
+ : parallelAiSearch_;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch,
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.Builder,
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearchOrBuilder>
+ internalGetParallelAiSearchFieldBuilder() {
+ if (parallelAiSearchBuilder_ == null) {
+ parallelAiSearchBuilder_ =
+ new com.google.protobuf.SingleFieldBuilder<
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch,
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch.Builder,
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearchOrBuilder>(
+ getParallelAiSearch(), getParentForChildren(), isClean());
+ parallelAiSearch_ = null;
+ }
+ return parallelAiSearchBuilder_;
+ }
+
private com.google.cloud.aiplatform.v1beta1.Tool.CodeExecution codeExecution_;
private com.google.protobuf.SingleFieldBuilder<
com.google.cloud.aiplatform.v1beta1.Tool.CodeExecution,
@@ -6046,7 +7614,7 @@ public Builder clearEnterpriseWebSearch() {
* @return Whether the codeExecution field is set.
*/
public boolean hasCodeExecution() {
- return ((bitField0_ & 0x00000040) != 0);
+ return ((bitField0_ & 0x00000080) != 0);
}
/**
@@ -6094,7 +7662,7 @@ public Builder setCodeExecution(com.google.cloud.aiplatform.v1beta1.Tool.CodeExe
} else {
codeExecutionBuilder_.setMessage(value);
}
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
onChanged();
return this;
}
@@ -6118,7 +7686,7 @@ public Builder setCodeExecution(
} else {
codeExecutionBuilder_.setMessage(builderForValue.build());
}
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
onChanged();
return this;
}
@@ -6138,7 +7706,7 @@ public Builder setCodeExecution(
public Builder mergeCodeExecution(
com.google.cloud.aiplatform.v1beta1.Tool.CodeExecution value) {
if (codeExecutionBuilder_ == null) {
- if (((bitField0_ & 0x00000040) != 0)
+ if (((bitField0_ & 0x00000080) != 0)
&& codeExecution_ != null
&& codeExecution_
!= com.google.cloud.aiplatform.v1beta1.Tool.CodeExecution.getDefaultInstance()) {
@@ -6150,7 +7718,7 @@ public Builder mergeCodeExecution(
codeExecutionBuilder_.mergeFrom(value);
}
if (codeExecution_ != null) {
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
onChanged();
}
return this;
@@ -6169,7 +7737,7 @@ public Builder mergeCodeExecution(
*
*/
public Builder clearCodeExecution() {
- bitField0_ = (bitField0_ & ~0x00000040);
+ bitField0_ = (bitField0_ & ~0x00000080);
codeExecution_ = null;
if (codeExecutionBuilder_ != null) {
codeExecutionBuilder_.dispose();
@@ -6193,7 +7761,7 @@ public Builder clearCodeExecution() {
*/
public com.google.cloud.aiplatform.v1beta1.Tool.CodeExecution.Builder
getCodeExecutionBuilder() {
- bitField0_ |= 0x00000040;
+ bitField0_ |= 0x00000080;
onChanged();
return internalGetCodeExecutionFieldBuilder().getBuilder();
}
@@ -6271,7 +7839,7 @@ public Builder clearCodeExecution() {
* @return Whether the urlContext field is set.
*/
public boolean hasUrlContext() {
- return ((bitField0_ & 0x00000080) != 0);
+ return ((bitField0_ & 0x00000100) != 0);
}
/**
@@ -6317,7 +7885,7 @@ public Builder setUrlContext(com.google.cloud.aiplatform.v1beta1.UrlContext valu
} else {
urlContextBuilder_.setMessage(value);
}
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
onChanged();
return this;
}
@@ -6340,7 +7908,7 @@ public Builder setUrlContext(
} else {
urlContextBuilder_.setMessage(builderForValue.build());
}
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
onChanged();
return this;
}
@@ -6358,7 +7926,7 @@ public Builder setUrlContext(
*/
public Builder mergeUrlContext(com.google.cloud.aiplatform.v1beta1.UrlContext value) {
if (urlContextBuilder_ == null) {
- if (((bitField0_ & 0x00000080) != 0)
+ if (((bitField0_ & 0x00000100) != 0)
&& urlContext_ != null
&& urlContext_ != com.google.cloud.aiplatform.v1beta1.UrlContext.getDefaultInstance()) {
getUrlContextBuilder().mergeFrom(value);
@@ -6369,7 +7937,7 @@ public Builder mergeUrlContext(com.google.cloud.aiplatform.v1beta1.UrlContext va
urlContextBuilder_.mergeFrom(value);
}
if (urlContext_ != null) {
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
onChanged();
}
return this;
@@ -6387,7 +7955,7 @@ public Builder mergeUrlContext(com.google.cloud.aiplatform.v1beta1.UrlContext va
*
*/
public Builder clearUrlContext() {
- bitField0_ = (bitField0_ & ~0x00000080);
+ bitField0_ = (bitField0_ & ~0x00000100);
urlContext_ = null;
if (urlContextBuilder_ != null) {
urlContextBuilder_.dispose();
@@ -6409,7 +7977,7 @@ public Builder clearUrlContext() {
*
*/
public com.google.cloud.aiplatform.v1beta1.UrlContext.Builder getUrlContextBuilder() {
- bitField0_ |= 0x00000080;
+ bitField0_ |= 0x00000100;
onChanged();
return internalGetUrlContextFieldBuilder().getBuilder();
}
@@ -6486,7 +8054,7 @@ public com.google.cloud.aiplatform.v1beta1.UrlContextOrBuilder getUrlContextOrBu
* @return Whether the computerUse field is set.
*/
public boolean hasComputerUse() {
- return ((bitField0_ & 0x00000100) != 0);
+ return ((bitField0_ & 0x00000200) != 0);
}
/**
@@ -6536,7 +8104,7 @@ public Builder setComputerUse(com.google.cloud.aiplatform.v1beta1.Tool.ComputerU
} else {
computerUseBuilder_.setMessage(value);
}
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
onChanged();
return this;
}
@@ -6561,7 +8129,7 @@ public Builder setComputerUse(
} else {
computerUseBuilder_.setMessage(builderForValue.build());
}
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
onChanged();
return this;
}
@@ -6581,7 +8149,7 @@ public Builder setComputerUse(
*/
public Builder mergeComputerUse(com.google.cloud.aiplatform.v1beta1.Tool.ComputerUse value) {
if (computerUseBuilder_ == null) {
- if (((bitField0_ & 0x00000100) != 0)
+ if (((bitField0_ & 0x00000200) != 0)
&& computerUse_ != null
&& computerUse_
!= com.google.cloud.aiplatform.v1beta1.Tool.ComputerUse.getDefaultInstance()) {
@@ -6593,7 +8161,7 @@ public Builder mergeComputerUse(com.google.cloud.aiplatform.v1beta1.Tool.Compute
computerUseBuilder_.mergeFrom(value);
}
if (computerUse_ != null) {
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
onChanged();
}
return this;
@@ -6613,7 +8181,7 @@ public Builder mergeComputerUse(com.google.cloud.aiplatform.v1beta1.Tool.Compute
*
*/
public Builder clearComputerUse() {
- bitField0_ = (bitField0_ & ~0x00000100);
+ bitField0_ = (bitField0_ & ~0x00000200);
computerUse_ = null;
if (computerUseBuilder_ != null) {
computerUseBuilder_.dispose();
@@ -6637,7 +8205,7 @@ public Builder clearComputerUse() {
*
*/
public com.google.cloud.aiplatform.v1beta1.Tool.ComputerUse.Builder getComputerUseBuilder() {
- bitField0_ |= 0x00000100;
+ bitField0_ |= 0x00000200;
onChanged();
return internalGetComputerUseFieldBuilder().getBuilder();
}
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/ToolOrBuilder.java b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/ToolOrBuilder.java
index 78888578fc7d..0c8930b4a523 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/ToolOrBuilder.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/ToolOrBuilder.java
@@ -377,6 +377,55 @@ com.google.cloud.aiplatform.v1beta1.FunctionDeclarationOrBuilder getFunctionDecl
com.google.cloud.aiplatform.v1beta1.EnterpriseWebSearchOrBuilder
getEnterpriseWebSearchOrBuilder();
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return Whether the parallelAiSearch field is set.
+ */
+ boolean hasParallelAiSearch();
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ *
+ * @return The parallelAiSearch.
+ */
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch getParallelAiSearch();
+
+ /**
+ *
+ *
+ * + * Optional. If specified, Vertex AI will use Parallel.ai to search for + * information to answer user queries. The search results will be grounded on + * Parallel.ai and presented to the model for response generation + *+ * + *
+ * .google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ */
+ com.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearchOrBuilder getParallelAiSearchOrBuilder();
+
/**
*
*
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/ToolProto.java b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/ToolProto.java
index 2623abeefa37..5a800ffa6410 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/ToolProto.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/ToolProto.java
@@ -48,6 +48,10 @@ public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry r
internal_static_google_cloud_aiplatform_v1beta1_Tool_GoogleSearch_descriptor;
static final com.google.protobuf.GeneratedMessage.FieldAccessorTable
internal_static_google_cloud_aiplatform_v1beta1_Tool_GoogleSearch_fieldAccessorTable;
+ static final com.google.protobuf.Descriptors.Descriptor
+ internal_static_google_cloud_aiplatform_v1beta1_Tool_ParallelAiSearch_descriptor;
+ static final com.google.protobuf.GeneratedMessage.FieldAccessorTable
+ internal_static_google_cloud_aiplatform_v1beta1_Tool_ParallelAiSearch_fieldAccessorTable;
static final com.google.protobuf.Descriptors.Descriptor
internal_static_google_cloud_aiplatform_v1beta1_Tool_CodeExecution_descriptor;
static final com.google.protobuf.GeneratedMessage.FieldAccessorTable
@@ -191,7 +195,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "oogle/api/field_behavior.proto\032\031google/a"
+ "pi/resource.proto\032-google/cloud/aiplatfo"
+ "rm/v1beta1/openapi.proto\032\034google/protobu"
- + "f/struct.proto\032\030google/type/latlng.proto\"\342\n\n"
+ + "f/struct.proto\032\030google/type/latlng.proto\"\233\014\n"
+ "\004Tool\022X\n"
+ "\025function_declarations\030\001 \003(\013"
+ "24.google.cloud.aiplatform.v1beta1.FunctionDeclarationB\003\340A\001\022B\n"
@@ -204,22 +208,28 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\013google_maps\030\005 \001"
+ "(\0132+.google.cloud.aiplatform.v1beta1.GoogleMapsB\003\340A\001\022X\n"
+ "\025enterprise_web_search\030\006 "
- + "\001(\01324.google.cloud.aiplatform.v1beta1.EnterpriseWebSearchB\003\340A\001\022P\n"
+ + "\001(\01324.google.cloud.aiplatform.v1beta1.EnterpriseWebSearchB\003\340A\001\022W\n"
+ + "\022parallel_ai_search\030\r"
+ + " \001(\01326.google.cloud.aiplatform.v1beta1.Tool.ParallelAiSearchB\003\340A\001\022P\n"
+ "\016code_execution\030\004"
+ " \001(\01323.google.cloud.aiplatform.v1beta1.Tool.CodeExecutionB\003\340A\001\022E\n"
+ "\013url_context\030\n"
+ " \001(\0132+.google.cloud.aiplatform.v1beta1.UrlContextB\003\340A\001\022L\n"
- + "\014computer_use\030\013 \001(\01321."
- + "google.cloud.aiplatform.v1beta1.Tool.ComputerUseB\003\340A\001\032\246\001\n"
+ + "\014computer_use\030\013"
+ + " \001(\01321.google.cloud.aiplatform.v1beta1.Tool.ComputerUseB\003\340A\001\032\246\001\n"
+ "\014GoogleSearch\022\034\n"
+ "\017exclude_domains\030\003 \003(\tB\003\340A\001\022`\n"
- + "\023blocking_confidence\030\004 \001(\01629.google.cloud.aiplatform.v1be"
- + "ta1.Tool.PhishBlockThresholdB\003\340A\001H\000\210\001\001B\026\n"
- + "\024_blocking_confidence\032\017\n\r"
+ + "\023blocking_confidence\030\004 \001(\01629.google.cloud.aiplat"
+ + "form.v1beta1.Tool.PhishBlockThresholdB\003\340A\001H\000\210\001\001B\026\n"
+ + "\024_blocking_confidence\032^\n"
+ + "\020ParallelAiSearch\022\024\n"
+ + "\007api_key\030\001 \001(\tB\003\340A\001\0224\n"
+ + "\016custom_configs\030\003"
+ + " \001(\0132\027.google.protobuf.StructB\003\340A\001\032\017\n\r"
+ "CodeExecution\032\327\001\n"
+ "\013ComputerUse\022W\n"
- + "\013environment\030\001 \001(\0162=.g"
- + "oogle.cloud.aiplatform.v1beta1.Tool.ComputerUse.EnvironmentB\003\340A\002\022*\n"
+ + "\013environment\030\001 \001(\0162=.google.cloud.aip"
+ + "latform.v1beta1.Tool.ComputerUse.EnvironmentB\003\340A\002\022*\n"
+ "\035excluded_predefined_functions\030\002 \003(\tB\003\340A\001\"C\n"
+ "\013Environment\022\033\n"
+ "\027ENVIRONMENT_UNSPECIFIED\020\000\022\027\n"
@@ -236,7 +246,8 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "UrlContext\"\260\003\n"
+ "\016ToolUseExample\022a\n"
+ "\023extension_operation\030\n"
- + " \001(\0132B.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperationH\000\022\027\n\r"
+ + " \001(\0132B.google.cl"
+ + "oud.aiplatform.v1beta1.ToolUseExample.ExtensionOperationH\000\022\027\n\r"
+ "function_name\030\013 \001(\tH\000\022\031\n"
+ "\014display_name\030\001 \001(\tB\003\340A\002\022\022\n"
+ "\005query\030\002 \001(\tB\003\340A\002\022/\n"
@@ -251,8 +262,8 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\023FunctionDeclaration\022\021\n"
+ "\004name\030\001 \001(\tB\003\340A\002\022\030\n"
+ "\013description\030\002 \001(\tB\003\340A\001\022@\n\n"
- + "parameters\030\003 \001(\0132"
- + "\'.google.cloud.aiplatform.v1beta1.SchemaB\003\340A\001\022;\n"
+ + "parameters\030\003"
+ + " \001(\0132\'.google.cloud.aiplatform.v1beta1.SchemaB\003\340A\001\022;\n"
+ "\026parameters_json_schema\030\005"
+ " \001(\0132\026.google.protobuf.ValueB\003\340A\001\022>\n"
+ "\010response\030\004"
@@ -263,8 +274,8 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\002id\030\003 \001(\tB\003\340A\001\022\021\n"
+ "\004name\030\001 \001(\tB\003\340A\001\022*\n"
+ "\004args\030\002 \001(\0132\027.google.protobuf.StructB\003\340A\001\022F\n"
- + "\014partial_args\030\004 \003(\0132+.google.cl"
- + "oud.aiplatform.v1beta1.PartialArgB\003\340A\001\022\032\n\r"
+ + "\014partial_args\030\004"
+ + " \003(\0132+.google.cloud.aiplatform.v1beta1.PartialArgB\003\340A\001\022\032\n\r"
+ "will_continue\030\005 \001(\010B\003\340A\001\"\325\001\n\n"
+ "PartialArg\0225\n\n"
+ "null_value\030\002"
@@ -276,10 +287,10 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "will_continue\030\006 \001(\010B\003\340A\001B\007\n"
+ "\005delta\"\274\001\n"
+ "\024FunctionResponsePart\022L\n"
- + "\013inline_data\030\001"
- + " \001(\01325.google.cloud.aiplatform.v1beta1.FunctionResponseBlobH\000\022N\n"
- + "\tfile_data\030\002"
- + " \001(\01329.google.cloud.aiplatform.v1beta1.FunctionResponseFileDataH\000B\006\n"
+ + "\013inline_data\030\001 \001(\01325.goog"
+ + "le.cloud.aiplatform.v1beta1.FunctionResponseBlobH\000\022N\n"
+ + "\tfile_data\030\002 \001(\01329.google.c"
+ + "loud.aiplatform.v1beta1.FunctionResponseFileDataH\000B\006\n"
+ "\004data\"\\\n"
+ "\024FunctionResponseBlob\022\026\n"
+ "\tmime_type\030\001 \001(\tB\003\340A\002\022\021\n"
@@ -293,18 +304,18 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\002id\030\003 \001(\tB\003\340A\001\022\021\n"
+ "\004name\030\001 \001(\tB\003\340A\002\022.\n"
+ "\010response\030\002 \001(\0132\027.google.protobuf.StructB\003\340A\002\022I\n"
- + "\005parts\030\004 \003(\01325.google.c"
- + "loud.aiplatform.v1beta1.FunctionResponsePartB\003\340A\001\"\246\001\n"
+ + "\005parts\030\004"
+ + " \003(\01325.google.cloud.aiplatform.v1beta1.FunctionResponsePartB\003\340A\001\"\246\001\n"
+ "\016ExecutableCode\022O\n"
- + "\010language\030\001"
- + " \001(\01628.google.cloud.aiplatform.v1beta1.ExecutableCode.LanguageB\003\340A\002\022\021\n"
+ + "\010language\030\001 \001(\01628.google"
+ + ".cloud.aiplatform.v1beta1.ExecutableCode.LanguageB\003\340A\002\022\021\n"
+ "\004code\030\002 \001(\tB\003\340A\002\"0\n"
+ "\010Language\022\030\n"
+ "\024LANGUAGE_UNSPECIFIED\020\000\022\n\n"
+ "\006PYTHON\020\001\"\345\001\n"
+ "\023CodeExecutionResult\022R\n"
- + "\007outcome\030\001 \001(\0162<.google.cloud.aipla"
- + "tform.v1beta1.CodeExecutionResult.OutcomeB\003\340A\002\022\023\n"
+ + "\007outcome\030\001"
+ + " \001(\0162<.google.cloud.aiplatform.v1beta1.CodeExecutionResult.OutcomeB\003\340A\002\022\023\n"
+ "\006output\030\002 \001(\tB\003\340A\001\"e\n"
+ "\007Outcome\022\027\n"
+ "\023OUTCOME_UNSPECIFIED\020\000\022\016\n\n"
@@ -312,22 +323,22 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\016OUTCOME_FAILED\020\002\022\035\n"
+ "\031OUTCOME_DEADLINE_EXCEEDED\020\003\"\323\001\n"
+ "\tRetrieval\022K\n"
- + "\020vertex_ai_search\030\002"
- + " \001(\0132/.google.cloud.aiplatform.v1beta1.VertexAISearchH\000\022K\n"
- + "\020vertex_rag_store\030\004"
- + " \001(\0132/.google.cloud.aiplatform.v1beta1.VertexRagStoreH\000\022\"\n"
+ + "\020vertex_ai_search\030\002 \001(\0132/.go"
+ + "ogle.cloud.aiplatform.v1beta1.VertexAISearchH\000\022K\n"
+ + "\020vertex_rag_store\030\004 \001(\0132/.googl"
+ + "e.cloud.aiplatform.v1beta1.VertexRagStoreH\000\022\"\n"
+ "\023disable_attribution\030\003 \001(\010B\005\030\001\340A\001B\010\n"
+ "\006source\"\224\004\n"
+ "\016VertexRagStore\022B\n"
+ "\013rag_corpora\030\001 \003(\tB-\030\001\340A\001\372A%\n"
+ "#aiplatform.googleapis.com/RagCorpus\022W\n\r"
- + "rag_resources\030\004 \003(\0132;.google.cloud.aiplatform"
- + ".v1beta1.VertexRagStore.RagResourceB\003\340A\001\022$\n"
+ + "rag_resources\030\004 \003(\0132"
+ + ";.google.cloud.aiplatform.v1beta1.VertexRagStore.RagResourceB\003\340A\001\022$\n"
+ "\020similarity_top_k\030\002 \001(\005B\005\030\001\340A\001H\000\210\001\001\022-\n"
+ "\031vector_distance_threshold\030\003"
+ " \001(\001B\005\030\001\340A\001H\001\210\001\001\022V\n"
- + "\024rag_retrieval_config\030\006 \001(\01323.go"
- + "ogle.cloud.aiplatform.v1beta1.RagRetrievalConfigB\003\340A\001\022\032\n\r"
+ + "\024rag_retrieval_config\030\006 \001(\01323.google.cloud.aipl"
+ + "atform.v1beta1.RagRetrievalConfigB\003\340A\001\022\032\n\r"
+ "store_context\030\007 \001(\010B\003\340A\001\032i\n"
+ "\013RagResource\022?\n\n"
+ "rag_corpus\030\001 \001(\tB+\340A\001\372A%\n"
@@ -340,45 +351,44 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\006engine\030\002 \001(\tB\003\340A\001\022\030\n"
+ "\013max_results\030\003 \001(\005B\003\340A\001\022\023\n"
+ "\006filter\030\004 \001(\tB\003\340A\001\022W\n"
- + "\020data_store_specs\030\005 \003(\0132=.google.cloud.aiplatfo"
- + "rm.v1beta1.VertexAISearch.DataStoreSpec\0328\n\r"
+ + "\020data_store_specs\030\005 \003("
+ + "\0132=.google.cloud.aiplatform.v1beta1.VertexAISearch.DataStoreSpec\0328\n\r"
+ "DataStoreSpec\022\022\n\n"
+ "data_store\030\001 \001(\t\022\023\n"
+ "\006filter\030\002 \001(\tB\003\340A\001\"r\n"
+ "\025GoogleSearchRetrieval\022Y\n"
- + "\030dynamic_retrieval_config\030\002 \001(\01327.g"
- + "oogle.cloud.aiplatform.v1beta1.DynamicRetrievalConfig\"(\n\n"
+ + "\030dynamic_retrieval_config\030\002 \001(\01327.google.cloud.aip"
+ + "latform.v1beta1.DynamicRetrievalConfig\"(\n\n"
+ "GoogleMaps\022\032\n\r"
+ "enable_widget\030\001 \001(\010B\003\340A\001\"\255\001\n"
+ "\023EnterpriseWebSearch\022\034\n"
+ "\017exclude_domains\030\001 \003(\tB\003\340A\001\022`\n"
- + "\023blocking_confidence\030\004 \001(\01629.google.cloud.aiplat"
- + "form.v1beta1.Tool.PhishBlockThresholdB\003\340A\001H\000\210\001\001B\026\n"
+ + "\023blocking_confidence\030\004 "
+ + "\001(\01629.google.cloud.aiplatform.v1beta1.Tool.PhishBlockThresholdB\003\340A\001H\000\210\001\001B\026\n"
+ "\024_blocking_confidence\"\317\001\n"
+ "\026DynamicRetrievalConfig\022J\n"
- + "\004mode\030\001 \001(\0162<.googl"
- + "e.cloud.aiplatform.v1beta1.DynamicRetrievalConfig.Mode\022#\n"
+ + "\004mode\030\001 \001(\0162<.google.cloud.aiplatf"
+ + "orm.v1beta1.DynamicRetrievalConfig.Mode\022#\n"
+ "\021dynamic_threshold\030\002 \001(\002B\003\340A\001H\000\210\001\001\".\n"
+ "\004Mode\022\024\n"
+ "\020MODE_UNSPECIFIED\020\000\022\020\n"
+ "\014MODE_DYNAMIC\020\001B\024\n"
+ "\022_dynamic_threshold\"\273\001\n\n"
+ "ToolConfig\022\\\n"
- + "\027function_calling_config\030\001"
- + " \001(\01326.google.cloud.aiplatform.v1beta1.FunctionCallingConfigB\003\340A\001\022O\n"
- + "\020retrieval_config\030\002"
- + " \001(\01320.google.cloud.aiplatform.v1beta1.RetrievalConfigB\003\340A\001\"\211\002\n"
+ + "\027function_calling_config\030\001 \001(\01326.goo"
+ + "gle.cloud.aiplatform.v1beta1.FunctionCallingConfigB\003\340A\001\022O\n"
+ + "\020retrieval_config\030\002 \001("
+ + "\01320.google.cloud.aiplatform.v1beta1.RetrievalConfigB\003\340A\001\"\211\002\n"
+ "\025FunctionCallingConfig\022N\n"
- + "\004mode\030\001 \001(\0162;.google"
- + ".cloud.aiplatform.v1beta1.FunctionCallingConfig.ModeB\003\340A\001\022#\n"
+ + "\004mode\030\001 \001(\0162;.google.cloud.aiplatfo"
+ + "rm.v1beta1.FunctionCallingConfig.ModeB\003\340A\001\022#\n"
+ "\026allowed_function_names\030\002 \003(\tB\003\340A\001\022+\n"
+ "\036stream_function_call_arguments\030\004 \001(\010B\003\340A\001\"N\n"
+ "\004Mode\022\024\n"
+ "\020MODE_UNSPECIFIED\020\000\022\010\n"
+ "\004AUTO\020\001\022\007\n"
+ "\003ANY\020\002\022\010\n"
- + "\004NONE\020\003\022\r"
- + "\n"
+ + "\004NONE\020\003\022\r\n"
+ "\tVALIDATED\020\005\"\004\010\004\020\004\"v\n"
+ "\017RetrievalConfig\022)\n"
+ "\007lat_lng\030\001 \001(\0132\023.google.type.LatLngH\000\210\001\001\022\032\n\r"
@@ -387,12 +397,12 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\016_language_code\"\317\006\n"
+ "\022RagRetrievalConfig\022\022\n"
+ "\005top_k\030\001 \001(\005B\003\340A\001\022\\\n\r"
- + "hybrid_search\030\002"
- + " \001(\0132@.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.HybridSearchB\003\340A\001\022O\n"
- + "\006filter\030\003"
- + " \001(\0132:.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.FilterB\003\340A\001\022Q\n"
- + "\007ranking\030\004 \001(\0132;.google.cloud.aiplatform"
- + ".v1beta1.RagRetrievalConfig.RankingB\003\340A\001\0321\n"
+ + "hybrid_search\030\002 \001(\0132@.google."
+ + "cloud.aiplatform.v1beta1.RagRetrievalConfig.HybridSearchB\003\340A\001\022O\n"
+ + "\006filter\030\003 \001(\0132:."
+ + "google.cloud.aiplatform.v1beta1.RagRetrievalConfig.FilterB\003\340A\001\022Q\n"
+ + "\007ranking\030\004 \001(\0132"
+ + ";.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.RankingB\003\340A\001\0321\n"
+ "\014HybridSearch\022\027\n"
+ "\005alpha\030\001 \001(\002B\003\340A\001H\000\210\001\001B\010\n"
+ "\006_alpha\032\223\001\n"
@@ -402,10 +412,10 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "\017metadata_filter\030\002 \001(\tB\003\340A\001B\025\n"
+ "\023vector_db_threshold\032\331\002\n"
+ "\007Ranking\022d\n"
- + "\014rank_service\030\001 \001(\0132G.go"
- + "ogle.cloud.aiplatform.v1beta1.RagRetrievalConfig.Ranking.RankServiceB\003\340A\001H\000\022`\n\n"
- + "llm_ranker\030\003 \001(\0132E.google.cloud.aiplatfor"
- + "m.v1beta1.RagRetrievalConfig.Ranking.LlmRankerB\003\340A\001H\000\032:\n"
+ + "\014rank_service\030\001 \001(\0132G.google.cloud.aipl"
+ + "atform.v1beta1.RagRetrievalConfig.Ranking.RankServiceB\003\340A\001H\000\022`\n\n"
+ + "llm_ranker\030\003 \001(\0132E.google.cloud.aiplatform.v1beta1.RagRe"
+ + "trievalConfig.Ranking.LlmRankerB\003\340A\001H\000\032:\n"
+ "\013RankService\022\034\n\n"
+ "model_name\030\001 \001(\tB\003\340A\001H\000\210\001\001B\r\n"
+ "\013_model_name\0328\n"
@@ -413,11 +423,11 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "model_name\030\001 \001(\tB\003\340A\001H\000\210\001\001B\r\n"
+ "\013_model_nameB\020\n"
+ "\016ranking_configB\340\001\n"
- + "#com.google.cloud.aiplatform.v1beta1B\tToolProto"
- + "P\001ZCcloud.google.com/go/aiplatform/apiv1"
- + "beta1/aiplatformpb;aiplatformpb\252\002\037Google"
- + ".Cloud.AIPlatform.V1Beta1\312\002\037Google\\Cloud"
- + "\\AIPlatform\\V1beta1\352\002\"Google::Cloud::AIPlatform::V1beta1b\006proto3"
+ + "#com.google.cloud.aiplatform.v1beta1B\tToolProtoP\001ZCcloud.googl"
+ + "e.com/go/aiplatform/apiv1beta1/aiplatfor"
+ + "mpb;aiplatformpb\252\002\037Google.Cloud.AIPlatfo"
+ + "rm.V1Beta1\312\002\037Google\\Cloud\\AIPlatform\\V1b"
+ + "eta1\352\002\"Google::Cloud::AIPlatform::V1beta1b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
@@ -441,6 +451,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
"GoogleSearchRetrieval",
"GoogleMaps",
"EnterpriseWebSearch",
+ "ParallelAiSearch",
"CodeExecution",
"UrlContext",
"ComputerUse",
@@ -453,14 +464,22 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
new java.lang.String[] {
"ExcludeDomains", "BlockingConfidence",
});
- internal_static_google_cloud_aiplatform_v1beta1_Tool_CodeExecution_descriptor =
+ internal_static_google_cloud_aiplatform_v1beta1_Tool_ParallelAiSearch_descriptor =
internal_static_google_cloud_aiplatform_v1beta1_Tool_descriptor.getNestedType(1);
+ internal_static_google_cloud_aiplatform_v1beta1_Tool_ParallelAiSearch_fieldAccessorTable =
+ new com.google.protobuf.GeneratedMessage.FieldAccessorTable(
+ internal_static_google_cloud_aiplatform_v1beta1_Tool_ParallelAiSearch_descriptor,
+ new java.lang.String[] {
+ "ApiKey", "CustomConfigs",
+ });
+ internal_static_google_cloud_aiplatform_v1beta1_Tool_CodeExecution_descriptor =
+ internal_static_google_cloud_aiplatform_v1beta1_Tool_descriptor.getNestedType(2);
internal_static_google_cloud_aiplatform_v1beta1_Tool_CodeExecution_fieldAccessorTable =
new com.google.protobuf.GeneratedMessage.FieldAccessorTable(
internal_static_google_cloud_aiplatform_v1beta1_Tool_CodeExecution_descriptor,
new java.lang.String[] {});
internal_static_google_cloud_aiplatform_v1beta1_Tool_ComputerUse_descriptor =
- internal_static_google_cloud_aiplatform_v1beta1_Tool_descriptor.getNestedType(2);
+ internal_static_google_cloud_aiplatform_v1beta1_Tool_descriptor.getNestedType(3);
internal_static_google_cloud_aiplatform_v1beta1_Tool_ComputerUse_fieldAccessorTable =
new com.google.protobuf.GeneratedMessage.FieldAccessorTable(
internal_static_google_cloud_aiplatform_v1beta1_Tool_ComputerUse_descriptor,
diff --git a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/VertexRagStore.java b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/VertexRagStore.java
index 511bff9f54b4..899f906f19d9 100644
--- a/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/VertexRagStore.java
+++ b/java-aiplatform/proto-google-cloud-aiplatform-v1beta1/src/main/java/com/google/cloud/aiplatform/v1beta1/VertexRagStore.java
@@ -1102,7 +1102,7 @@ public com.google.protobuf.ParserSheetExportAudienceList
Exports an audience list of users to a Google Sheet. After creating an audience, the users are not immediately available for listing. First, a request to `CreateAudienceList` is necessary to create an audience list of users, and then second, this method is used to export those users in the audience list to a Google Sheet. - *
See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. - *
Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. - *
This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
Request object method variants only take one parameter, a request object, which must be constructed before the call.
- *sheetExportAudienceList(SheetExportAudienceListRequest request) - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
- *sheetExportAudienceList(AudienceListName name) - *
sheetExportAudienceList(String name) - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
- *sheetExportAudienceListCallable() - *
GetAudienceList
Gets configuration metadata about a specific audience list. This method can be used to understand an audience list after it has been created. *
See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. @@ -364,6 +342,40 @@ * *
RunReport
Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.
Request object method variants only take one parameter, a request object, which must be constructed before the call.
+ *runReport(RunReportRequest request) + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
+ *runReportCallable() + *
GetMetadata
Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. + *
For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.
Request object method variants only take one parameter, a request object, which must be constructed before the call.
+ *getMetadata(GetMetadataRequest request) + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
+ *getMetadata(MetadataName name) + *
getMetadata(String name) + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
+ *getMetadataCallable() + *
See the individual methods for example code. @@ -995,189 +1007,6 @@ public final QueryAudienceListResponse queryAudienceList(QueryAudienceListReques return stub.queryAudienceListCallable(); } - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Exports an audience list of users to a Google Sheet. After creating an audience, the users are - * not immediately available for listing. First, a request to `CreateAudienceList` is necessary to - * create an audience list of users, and then second, this method is used to export those users in - * the audience list to a Google Sheet. - * - *
See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * - *
Audiences in Google Analytics 4 allow you to segment your users in the ways that are - * important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * - *
This method is introduced at alpha stability with the intention of gathering feedback on - * syntax and capabilities before entering beta. To give your feedback on this API, complete the - * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
- * AudienceListName name = AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]");
- * SheetExportAudienceListResponse response =
- * alphaAnalyticsDataClient.sheetExportAudienceList(name);
- * }
- * }
- *
- * @param name Required. The name of the audience list to retrieve users from. Format:
- * `properties/{property}/audienceLists/{audience_list}`
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final SheetExportAudienceListResponse sheetExportAudienceList(AudienceListName name) {
- SheetExportAudienceListRequest request =
- SheetExportAudienceListRequest.newBuilder()
- .setName(name == null ? null : name.toString())
- .build();
- return sheetExportAudienceList(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Exports an audience list of users to a Google Sheet. After creating an audience, the users are
- * not immediately available for listing. First, a request to `CreateAudienceList` is necessary to
- * create an audience list of users, and then second, this method is used to export those users in
- * the audience list to a Google Sheet.
- *
- * See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * - *
Audiences in Google Analytics 4 allow you to segment your users in the ways that are - * important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * - *
This method is introduced at alpha stability with the intention of gathering feedback on - * syntax and capabilities before entering beta. To give your feedback on this API, complete the - * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
- * String name = AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString();
- * SheetExportAudienceListResponse response =
- * alphaAnalyticsDataClient.sheetExportAudienceList(name);
- * }
- * }
- *
- * @param name Required. The name of the audience list to retrieve users from. Format:
- * `properties/{property}/audienceLists/{audience_list}`
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final SheetExportAudienceListResponse sheetExportAudienceList(String name) {
- SheetExportAudienceListRequest request =
- SheetExportAudienceListRequest.newBuilder().setName(name).build();
- return sheetExportAudienceList(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Exports an audience list of users to a Google Sheet. After creating an audience, the users are
- * not immediately available for listing. First, a request to `CreateAudienceList` is necessary to
- * create an audience list of users, and then second, this method is used to export those users in
- * the audience list to a Google Sheet.
- *
- * See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * - *
Audiences in Google Analytics 4 allow you to segment your users in the ways that are - * important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * - *
This method is introduced at alpha stability with the intention of gathering feedback on - * syntax and capabilities before entering beta. To give your feedback on this API, complete the - * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
- * SheetExportAudienceListRequest request =
- * SheetExportAudienceListRequest.newBuilder()
- * .setName(AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString())
- * .setOffset(-1019779949)
- * .setLimit(102976443)
- * .build();
- * SheetExportAudienceListResponse response =
- * alphaAnalyticsDataClient.sheetExportAudienceList(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final SheetExportAudienceListResponse sheetExportAudienceList(
- SheetExportAudienceListRequest request) {
- return sheetExportAudienceListCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Exports an audience list of users to a Google Sheet. After creating an audience, the users are
- * not immediately available for listing. First, a request to `CreateAudienceList` is necessary to
- * create an audience list of users, and then second, this method is used to export those users in
- * the audience list to a Google Sheet.
- *
- * See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * - *
Audiences in Google Analytics 4 allow you to segment your users in the ways that are - * important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * - *
This method is introduced at alpha stability with the intention of gathering feedback on - * syntax and capabilities before entering beta. To give your feedback on this API, complete the - * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
- * SheetExportAudienceListRequest request =
- * SheetExportAudienceListRequest.newBuilder()
- * .setName(AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString())
- * .setOffset(-1019779949)
- * .setLimit(102976443)
- * .build();
- * ApiFuture future =
- * alphaAnalyticsDataClient.sheetExportAudienceListCallable().futureCall(request);
- * // Do something.
- * SheetExportAudienceListResponse response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: + * + *
{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * RunReportRequest request =
+ * RunReportRequest.newBuilder()
+ * .setProperty("property-993141291")
+ * .addAllDimensions(new ArrayList())
+ * .addAllMetrics(new ArrayList())
+ * .addAllDateRanges(new ArrayList())
+ * .setDimensionFilter(FilterExpression.newBuilder().build())
+ * .setMetricFilter(FilterExpression.newBuilder().build())
+ * .setOffset(-1019779949)
+ * .setLimit(102976443)
+ * .addAllMetricAggregations(new ArrayList())
+ * .addAllOrderBys(new ArrayList())
+ * .setCurrencyCode("currencyCode1004773790")
+ * .setCohortSpec(CohortSpec.newBuilder().build())
+ * .setKeepEmptyRows(true)
+ * .setReturnPropertyQuota(true)
+ * .addAllComparisons(new ArrayList())
+ * .setConversionSpec(ConversionSpec.newBuilder().build())
+ * .build();
+ * RunReportResponse response = alphaAnalyticsDataClient.runReport(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final RunReportResponse runReport(RunReportRequest request) {
+ return runReportCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Returns a customized report of your Google Analytics event data. Reports contain statistics
+ * derived from data collected by the Google Analytics tracking code. The data returned from the
+ * API is as a table with columns for the requested dimensions and metrics. Metrics are individual
+ * measurements of user activity on your property, such as active users or event count. Dimensions
+ * break down metrics across some common criteria, such as country or event name.
+ *
+ * Sample code: + * + *
{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * RunReportRequest request =
+ * RunReportRequest.newBuilder()
+ * .setProperty("property-993141291")
+ * .addAllDimensions(new ArrayList())
+ * .addAllMetrics(new ArrayList())
+ * .addAllDateRanges(new ArrayList())
+ * .setDimensionFilter(FilterExpression.newBuilder().build())
+ * .setMetricFilter(FilterExpression.newBuilder().build())
+ * .setOffset(-1019779949)
+ * .setLimit(102976443)
+ * .addAllMetricAggregations(new ArrayList())
+ * .addAllOrderBys(new ArrayList())
+ * .setCurrencyCode("currencyCode1004773790")
+ * .setCohortSpec(CohortSpec.newBuilder().build())
+ * .setKeepEmptyRows(true)
+ * .setReturnPropertyQuota(true)
+ * .addAllComparisons(new ArrayList())
+ * .setConversionSpec(ConversionSpec.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * alphaAnalyticsDataClient.runReportCallable().futureCall(request);
+ * // Do something.
+ * RunReportResponse response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableFor example if a custom metric with parameter name `levels_unlocked` is registered to a + * property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata + * are dimensions and metrics applicable to any property such as `country` and `totalUsers`. + * + *
Sample code: + * + *
{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * MetadataName name = MetadataName.of("[PROPERTY]");
+ * Metadata response = alphaAnalyticsDataClient.getMetadata(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the metadata to retrieve. This name field is
+ * specified in the URL path and not URL parameters. Property is a numeric Google Analytics
+ * property identifier. To learn more, see [where to find your Property
+ * ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+ * Example: properties/1234/metadata + *
Set the Property ID to 0 for dimensions and metrics common to all properties. In this + * special mode, this method will not return custom dimensions and metrics. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Metadata getMetadata(MetadataName name) { + GetMetadataRequest request = + GetMetadataRequest.newBuilder().setName(name == null ? null : name.toString()).build(); + return getMetadata(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * Returns metadata for dimensions and metrics available in reporting methods. Used to explore the + * dimensions and metrics. In this method, a Google Analytics property identifier is specified in + * the request, and the metadata response includes Custom dimensions and metrics as well as + * Universal metadata. + * + *
For example if a custom metric with parameter name `levels_unlocked` is registered to a + * property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata + * are dimensions and metrics applicable to any property such as `country` and `totalUsers`. + * + *
Sample code: + * + *
{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * String name = MetadataName.of("[PROPERTY]").toString();
+ * Metadata response = alphaAnalyticsDataClient.getMetadata(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the metadata to retrieve. This name field is
+ * specified in the URL path and not URL parameters. Property is a numeric Google Analytics
+ * property identifier. To learn more, see [where to find your Property
+ * ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+ * Example: properties/1234/metadata + *
Set the Property ID to 0 for dimensions and metrics common to all properties. In this + * special mode, this method will not return custom dimensions and metrics. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Metadata getMetadata(String name) { + GetMetadataRequest request = GetMetadataRequest.newBuilder().setName(name).build(); + return getMetadata(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * Returns metadata for dimensions and metrics available in reporting methods. Used to explore the + * dimensions and metrics. In this method, a Google Analytics property identifier is specified in + * the request, and the metadata response includes Custom dimensions and metrics as well as + * Universal metadata. + * + *
For example if a custom metric with parameter name `levels_unlocked` is registered to a + * property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata + * are dimensions and metrics applicable to any property such as `country` and `totalUsers`. + * + *
Sample code: + * + *
{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * GetMetadataRequest request =
+ * GetMetadataRequest.newBuilder().setName(MetadataName.of("[PROPERTY]").toString()).build();
+ * Metadata response = alphaAnalyticsDataClient.getMetadata(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Metadata getMetadata(GetMetadataRequest request) {
+ return getMetadataCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
+ * dimensions and metrics. In this method, a Google Analytics property identifier is specified in
+ * the request, and the metadata response includes Custom dimensions and metrics as well as
+ * Universal metadata.
+ *
+ * For example if a custom metric with parameter name `levels_unlocked` is registered to a + * property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata + * are dimensions and metrics applicable to any property such as `country` and `totalUsers`. + * + *
Sample code: + * + *
{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * GetMetadataRequest request =
+ * GetMetadataRequest.newBuilder().setName(MetadataName.of("[PROPERTY]").toString()).build();
+ * ApiFuture future =
+ * alphaAnalyticsDataClient.getMetadataCallable().futureCall(request);
+ * // Do something.
+ * Metadata response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallable- * Exports an audience list of users to a Google Sheet. After creating an - * audience, the users are not immediately available for listing. First, a - * request to `CreateAudienceList` is necessary to create an audience list of - * users, and then second, this method is used to export those users in the - * audience list to a Google Sheet. - * See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * Audiences in Google Analytics 4 allow you to segment your users in the ways - * that are important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * This method is introduced at alpha stability with the intention of - * gathering feedback on syntax and capabilities before entering beta. To give - * your feedback on this API, complete the - * [Google Analytics Audience Export API - * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - *- */ - default void sheetExportAudienceList( - com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request, - io.grpc.stub.StreamObserver< - com.google.analytics.data.v1alpha.SheetExportAudienceListResponse> - responseObserver) { - io.grpc.stub.ServerCalls.asyncUnimplementedUnaryCall( - getSheetExportAudienceListMethod(), responseObserver); - } - /** * * @@ -1121,6 +1132,48 @@ default void listReportTasks( io.grpc.stub.ServerCalls.asyncUnimplementedUnaryCall( getListReportTasksMethod(), responseObserver); } + + /** + * + * + *
+ * Returns a customized report of your Google Analytics event data. Reports + * contain statistics derived from data collected by the Google Analytics + * tracking code. The data returned from the API is as a table with columns + * for the requested dimensions and metrics. Metrics are individual + * measurements of user activity on your property, such as active users or + * event count. Dimensions break down metrics across some common criteria, + * such as country or event name. + *+ */ + default void runReport( + com.google.analytics.data.v1alpha.RunReportRequest request, + io.grpc.stub.StreamObserver
+ * Returns metadata for dimensions and metrics available in reporting methods. + * Used to explore the dimensions and metrics. In this method, a Google + * Analytics property identifier is specified in the request, and + * the metadata response includes Custom dimensions and metrics as well as + * Universal metadata. + * For example if a custom metric with parameter name `levels_unlocked` is + * registered to a property, the Metadata response will contain + * `customEvent:levels_unlocked`. Universal metadata are dimensions and + * metrics applicable to any property such as `country` and `totalUsers`. + *+ */ + default void getMetadata( + com.google.analytics.data.v1alpha.GetMetadataRequest request, + io.grpc.stub.StreamObserver
- * Exports an audience list of users to a Google Sheet. After creating an - * audience, the users are not immediately available for listing. First, a - * request to `CreateAudienceList` is necessary to create an audience list of - * users, and then second, this method is used to export those users in the - * audience list to a Google Sheet. - * See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * Audiences in Google Analytics 4 allow you to segment your users in the ways - * that are important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * This method is introduced at alpha stability with the intention of - * gathering feedback on syntax and capabilities before entering beta. To give - * your feedback on this API, complete the - * [Google Analytics Audience Export API - * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - *- */ - public void sheetExportAudienceList( - com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request, - io.grpc.stub.StreamObserver< - com.google.analytics.data.v1alpha.SheetExportAudienceListResponse> - responseObserver) { - io.grpc.stub.ClientCalls.asyncUnaryCall( - getChannel().newCall(getSheetExportAudienceListMethod(), getCallOptions()), - request, - responseObserver); - } - /** * * @@ -1524,6 +1544,51 @@ public void listReportTasks( request, responseObserver); } + + /** + * + * + *
+ * Returns a customized report of your Google Analytics event data. Reports + * contain statistics derived from data collected by the Google Analytics + * tracking code. The data returned from the API is as a table with columns + * for the requested dimensions and metrics. Metrics are individual + * measurements of user activity on your property, such as active users or + * event count. Dimensions break down metrics across some common criteria, + * such as country or event name. + *+ */ + public void runReport( + com.google.analytics.data.v1alpha.RunReportRequest request, + io.grpc.stub.StreamObserver
+ * Returns metadata for dimensions and metrics available in reporting methods. + * Used to explore the dimensions and metrics. In this method, a Google + * Analytics property identifier is specified in the request, and + * the metadata response includes Custom dimensions and metrics as well as + * Universal metadata. + * For example if a custom metric with parameter name `levels_unlocked` is + * registered to a property, the Metadata response will contain + * `customEvent:levels_unlocked`. Universal metadata are dimensions and + * metrics applicable to any property such as `country` and `totalUsers`. + *+ */ + public void getMetadata( + com.google.analytics.data.v1alpha.GetMetadataRequest request, + io.grpc.stub.StreamObserver
- * Exports an audience list of users to a Google Sheet. After creating an - * audience, the users are not immediately available for listing. First, a - * request to `CreateAudienceList` is necessary to create an audience list of - * users, and then second, this method is used to export those users in the - * audience list to a Google Sheet. - * See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * Audiences in Google Analytics 4 allow you to segment your users in the ways - * that are important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * This method is introduced at alpha stability with the intention of - * gathering feedback on syntax and capabilities before entering beta. To give - * your feedback on this API, complete the - * [Google Analytics Audience Export API - * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - *- */ - public com.google.analytics.data.v1alpha.SheetExportAudienceListResponse - sheetExportAudienceList( - com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request) - throws io.grpc.StatusException { - return io.grpc.stub.ClientCalls.blockingV2UnaryCall( - getChannel(), getSheetExportAudienceListMethod(), getCallOptions(), request); - } - /** * * @@ -1872,6 +1907,47 @@ public com.google.analytics.data.v1alpha.ListReportTasksResponse listReportTasks return io.grpc.stub.ClientCalls.blockingV2UnaryCall( getChannel(), getListReportTasksMethod(), getCallOptions(), request); } + + /** + * + * + *
+ * Returns a customized report of your Google Analytics event data. Reports + * contain statistics derived from data collected by the Google Analytics + * tracking code. The data returned from the API is as a table with columns + * for the requested dimensions and metrics. Metrics are individual + * measurements of user activity on your property, such as active users or + * event count. Dimensions break down metrics across some common criteria, + * such as country or event name. + *+ */ + public com.google.analytics.data.v1alpha.RunReportResponse runReport( + com.google.analytics.data.v1alpha.RunReportRequest request) throws io.grpc.StatusException { + return io.grpc.stub.ClientCalls.blockingV2UnaryCall( + getChannel(), getRunReportMethod(), getCallOptions(), request); + } + + /** + * + * + *
+ * Returns metadata for dimensions and metrics available in reporting methods. + * Used to explore the dimensions and metrics. In this method, a Google + * Analytics property identifier is specified in the request, and + * the metadata response includes Custom dimensions and metrics as well as + * Universal metadata. + * For example if a custom metric with parameter name `levels_unlocked` is + * registered to a property, the Metadata response will contain + * `customEvent:levels_unlocked`. Universal metadata are dimensions and + * metrics applicable to any property such as `country` and `totalUsers`. + *+ */ + public com.google.analytics.data.v1alpha.Metadata getMetadata( + com.google.analytics.data.v1alpha.GetMetadataRequest request) + throws io.grpc.StatusException { + return io.grpc.stub.ClientCalls.blockingV2UnaryCall( + getChannel(), getGetMetadataMethod(), getCallOptions(), request); + } } /** @@ -1979,35 +2055,6 @@ public com.google.analytics.data.v1alpha.QueryAudienceListResponse queryAudience getChannel(), getQueryAudienceListMethod(), getCallOptions(), request); } - /** - * - * - *
- * Exports an audience list of users to a Google Sheet. After creating an - * audience, the users are not immediately available for listing. First, a - * request to `CreateAudienceList` is necessary to create an audience list of - * users, and then second, this method is used to export those users in the - * audience list to a Google Sheet. - * See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * Audiences in Google Analytics 4 allow you to segment your users in the ways - * that are important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * This method is introduced at alpha stability with the intention of - * gathering feedback on syntax and capabilities before entering beta. To give - * your feedback on this API, complete the - * [Google Analytics Audience Export API - * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - *- */ - public com.google.analytics.data.v1alpha.SheetExportAudienceListResponse - sheetExportAudienceList( - com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request) { - return io.grpc.stub.ClientCalls.blockingUnaryCall( - getChannel(), getSheetExportAudienceListMethod(), getCallOptions(), request); - } - /** * * @@ -2206,6 +2253,46 @@ public com.google.analytics.data.v1alpha.ListReportTasksResponse listReportTasks return io.grpc.stub.ClientCalls.blockingUnaryCall( getChannel(), getListReportTasksMethod(), getCallOptions(), request); } + + /** + * + * + *
+ * Returns a customized report of your Google Analytics event data. Reports + * contain statistics derived from data collected by the Google Analytics + * tracking code. The data returned from the API is as a table with columns + * for the requested dimensions and metrics. Metrics are individual + * measurements of user activity on your property, such as active users or + * event count. Dimensions break down metrics across some common criteria, + * such as country or event name. + *+ */ + public com.google.analytics.data.v1alpha.RunReportResponse runReport( + com.google.analytics.data.v1alpha.RunReportRequest request) { + return io.grpc.stub.ClientCalls.blockingUnaryCall( + getChannel(), getRunReportMethod(), getCallOptions(), request); + } + + /** + * + * + *
+ * Returns metadata for dimensions and metrics available in reporting methods. + * Used to explore the dimensions and metrics. In this method, a Google + * Analytics property identifier is specified in the request, and + * the metadata response includes Custom dimensions and metrics as well as + * Universal metadata. + * For example if a custom metric with parameter name `levels_unlocked` is + * registered to a property, the Metadata response will contain + * `customEvent:levels_unlocked`. Universal metadata are dimensions and + * metrics applicable to any property such as `country` and `totalUsers`. + *+ */ + public com.google.analytics.data.v1alpha.Metadata getMetadata( + com.google.analytics.data.v1alpha.GetMetadataRequest request) { + return io.grpc.stub.ClientCalls.blockingUnaryCall( + getChannel(), getGetMetadataMethod(), getCallOptions(), request); + } } /** @@ -2314,36 +2401,6 @@ protected AlphaAnalyticsDataFutureStub build( getChannel().newCall(getQueryAudienceListMethod(), getCallOptions()), request); } - /** - * - * - *
- * Exports an audience list of users to a Google Sheet. After creating an - * audience, the users are not immediately available for listing. First, a - * request to `CreateAudienceList` is necessary to create an audience list of - * users, and then second, this method is used to export those users in the - * audience list to a Google Sheet. - * See [Creating an Audience - * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) - * for an introduction to Audience Lists with examples. - * Audiences in Google Analytics 4 allow you to segment your users in the ways - * that are important to your business. To learn more, see - * https://support.google.com/analytics/answer/9267572. - * This method is introduced at alpha stability with the intention of - * gathering feedback on syntax and capabilities before entering beta. To give - * your feedback on this API, complete the - * [Google Analytics Audience Export API - * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. - *- */ - public com.google.common.util.concurrent.ListenableFuture< - com.google.analytics.data.v1alpha.SheetExportAudienceListResponse> - sheetExportAudienceList( - com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request) { - return io.grpc.stub.ClientCalls.futureUnaryCall( - getChannel().newCall(getSheetExportAudienceListMethod(), getCallOptions()), request); - } - /** * * @@ -2554,22 +2611,65 @@ protected AlphaAnalyticsDataFutureStub build( return io.grpc.stub.ClientCalls.futureUnaryCall( getChannel().newCall(getListReportTasksMethod(), getCallOptions()), request); } + + /** + * + * + *
+ * Returns a customized report of your Google Analytics event data. Reports + * contain statistics derived from data collected by the Google Analytics + * tracking code. The data returned from the API is as a table with columns + * for the requested dimensions and metrics. Metrics are individual + * measurements of user activity on your property, such as active users or + * event count. Dimensions break down metrics across some common criteria, + * such as country or event name. + *+ */ + public com.google.common.util.concurrent.ListenableFuture< + com.google.analytics.data.v1alpha.RunReportResponse> + runReport(com.google.analytics.data.v1alpha.RunReportRequest request) { + return io.grpc.stub.ClientCalls.futureUnaryCall( + getChannel().newCall(getRunReportMethod(), getCallOptions()), request); + } + + /** + * + * + *
+ * Returns metadata for dimensions and metrics available in reporting methods. + * Used to explore the dimensions and metrics. In this method, a Google + * Analytics property identifier is specified in the request, and + * the metadata response includes Custom dimensions and metrics as well as + * Universal metadata. + * For example if a custom metric with parameter name `levels_unlocked` is + * registered to a property, the Metadata response will contain + * `customEvent:levels_unlocked`. Universal metadata are dimensions and + * metrics applicable to any property such as `country` and `totalUsers`. + *+ */ + public com.google.common.util.concurrent.ListenableFuture< + com.google.analytics.data.v1alpha.Metadata> + getMetadata(com.google.analytics.data.v1alpha.GetMetadataRequest request) { + return io.grpc.stub.ClientCalls.futureUnaryCall( + getChannel().newCall(getGetMetadataMethod(), getCallOptions()), request); + } } private static final int METHODID_RUN_FUNNEL_REPORT = 0; private static final int METHODID_CREATE_AUDIENCE_LIST = 1; private static final int METHODID_QUERY_AUDIENCE_LIST = 2; - private static final int METHODID_SHEET_EXPORT_AUDIENCE_LIST = 3; - private static final int METHODID_GET_AUDIENCE_LIST = 4; - private static final int METHODID_LIST_AUDIENCE_LISTS = 5; - private static final int METHODID_CREATE_RECURRING_AUDIENCE_LIST = 6; - private static final int METHODID_GET_RECURRING_AUDIENCE_LIST = 7; - private static final int METHODID_LIST_RECURRING_AUDIENCE_LISTS = 8; - private static final int METHODID_GET_PROPERTY_QUOTAS_SNAPSHOT = 9; - private static final int METHODID_CREATE_REPORT_TASK = 10; - private static final int METHODID_QUERY_REPORT_TASK = 11; - private static final int METHODID_GET_REPORT_TASK = 12; - private static final int METHODID_LIST_REPORT_TASKS = 13; + private static final int METHODID_GET_AUDIENCE_LIST = 3; + private static final int METHODID_LIST_AUDIENCE_LISTS = 4; + private static final int METHODID_CREATE_RECURRING_AUDIENCE_LIST = 5; + private static final int METHODID_GET_RECURRING_AUDIENCE_LIST = 6; + private static final int METHODID_LIST_RECURRING_AUDIENCE_LISTS = 7; + private static final int METHODID_GET_PROPERTY_QUOTAS_SNAPSHOT = 8; + private static final int METHODID_CREATE_REPORT_TASK = 9; + private static final int METHODID_QUERY_REPORT_TASK = 10; + private static final int METHODID_GET_REPORT_TASK = 11; + private static final int METHODID_LIST_REPORT_TASKS = 12; + private static final int METHODID_RUN_REPORT = 13; + private static final int METHODID_GET_METADATA = 14; private static final class MethodHandlers
+ * Defines an individual comparison. Most requests will include multiple + * comparisons so that the report compares between the comparisons. + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.Comparison} + */ +@com.google.protobuf.Generated +public final class Comparison extends com.google.protobuf.GeneratedMessage + implements + // @@protoc_insertion_point(message_implements:google.analytics.data.v1alpha.Comparison) + ComparisonOrBuilder { + private static final long serialVersionUID = 0L; + + static { + com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion( + com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC, + /* major= */ 4, + /* minor= */ 33, + /* patch= */ 2, + /* suffix= */ "", + "Comparison"); + } + + // Use Comparison.newBuilder() to construct. + private Comparison(com.google.protobuf.GeneratedMessage.Builder builder) { + super(builder); + } + + private Comparison() { + name_ = ""; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_Comparison_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_Comparison_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.analytics.data.v1alpha.Comparison.class, + com.google.analytics.data.v1alpha.Comparison.Builder.class); + } + + private int bitField0_; + private int oneComparisonCase_ = 0; + + @SuppressWarnings("serial") + private java.lang.Object oneComparison_; + + public enum OneComparisonCase + implements + com.google.protobuf.Internal.EnumLite, + com.google.protobuf.AbstractMessage.InternalOneOfEnum { + DIMENSION_FILTER(2), + COMPARISON(3), + ONECOMPARISON_NOT_SET(0); + private final int value; + + private OneComparisonCase(int value) { + this.value = value; + } + + /** + * @param value The number of the enum to look for. + * @return The enum associated with the given number. + * @deprecated Use {@link #forNumber(int)} instead. + */ + @java.lang.Deprecated + public static OneComparisonCase valueOf(int value) { + return forNumber(value); + } + + public static OneComparisonCase forNumber(int value) { + switch (value) { + case 2: + return DIMENSION_FILTER; + case 3: + return COMPARISON; + case 0: + return ONECOMPARISON_NOT_SET; + default: + return null; + } + } + + public int getNumber() { + return this.value; + } + }; + + public OneComparisonCase getOneComparisonCase() { + return OneComparisonCase.forNumber(oneComparisonCase_); + } + + public static final int NAME_FIELD_NUMBER = 1; + + @SuppressWarnings("serial") + private volatile java.lang.Object name_ = ""; + + /** + * + * + *
+ * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return Whether the name field is set.
+ */
+ @java.lang.Override
+ public boolean hasName() {
+ return ((bitField0_ & 0x00000001) != 0);
+ }
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return The name.
+ */
+ @java.lang.Override
+ public java.lang.String getName() {
+ java.lang.Object ref = name_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ name_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return The bytes for name.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getNameBytes() {
+ java.lang.Object ref = name_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ name_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int DIMENSION_FILTER_FIELD_NUMBER = 2;
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ *
+ * @return Whether the dimensionFilter field is set.
+ */
+ @java.lang.Override
+ public boolean hasDimensionFilter() {
+ return oneComparisonCase_ == 2;
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ *
+ * @return The dimensionFilter.
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.FilterExpression getDimensionFilter() {
+ if (oneComparisonCase_ == 2) {
+ return (com.google.analytics.data.v1alpha.FilterExpression) oneComparison_;
+ }
+ return com.google.analytics.data.v1alpha.FilterExpression.getDefaultInstance();
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.FilterExpressionOrBuilder getDimensionFilterOrBuilder() {
+ if (oneComparisonCase_ == 2) {
+ return (com.google.analytics.data.v1alpha.FilterExpression) oneComparison_;
+ }
+ return com.google.analytics.data.v1alpha.FilterExpression.getDefaultInstance();
+ }
+
+ public static final int COMPARISON_FIELD_NUMBER = 3;
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return Whether the comparison field is set.
+ */
+ public boolean hasComparison() {
+ return oneComparisonCase_ == 3;
+ }
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return The comparison.
+ */
+ public java.lang.String getComparison() {
+ java.lang.Object ref = "";
+ if (oneComparisonCase_ == 3) {
+ ref = oneComparison_;
+ }
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ if (oneComparisonCase_ == 3) {
+ oneComparison_ = s;
+ }
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return The bytes for comparison.
+ */
+ public com.google.protobuf.ByteString getComparisonBytes() {
+ java.lang.Object ref = "";
+ if (oneComparisonCase_ == 3) {
+ ref = oneComparison_;
+ }
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ if (oneComparisonCase_ == 3) {
+ oneComparison_ = b;
+ }
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ if (((bitField0_ & 0x00000001) != 0)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 1, name_);
+ }
+ if (oneComparisonCase_ == 2) {
+ output.writeMessage(2, (com.google.analytics.data.v1alpha.FilterExpression) oneComparison_);
+ }
+ if (oneComparisonCase_ == 3) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 3, oneComparison_);
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (((bitField0_ & 0x00000001) != 0)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(1, name_);
+ }
+ if (oneComparisonCase_ == 2) {
+ size +=
+ com.google.protobuf.CodedOutputStream.computeMessageSize(
+ 2, (com.google.analytics.data.v1alpha.FilterExpression) oneComparison_);
+ }
+ if (oneComparisonCase_ == 3) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(3, oneComparison_);
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.analytics.data.v1alpha.Comparison)) {
+ return super.equals(obj);
+ }
+ com.google.analytics.data.v1alpha.Comparison other =
+ (com.google.analytics.data.v1alpha.Comparison) obj;
+
+ if (hasName() != other.hasName()) return false;
+ if (hasName()) {
+ if (!getName().equals(other.getName())) return false;
+ }
+ if (!getOneComparisonCase().equals(other.getOneComparisonCase())) return false;
+ switch (oneComparisonCase_) {
+ case 2:
+ if (!getDimensionFilter().equals(other.getDimensionFilter())) return false;
+ break;
+ case 3:
+ if (!getComparison().equals(other.getComparison())) return false;
+ break;
+ case 0:
+ default:
+ }
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ if (hasName()) {
+ hash = (37 * hash) + NAME_FIELD_NUMBER;
+ hash = (53 * hash) + getName().hashCode();
+ }
+ switch (oneComparisonCase_) {
+ case 2:
+ hash = (37 * hash) + DIMENSION_FILTER_FIELD_NUMBER;
+ hash = (53 * hash) + getDimensionFilter().hashCode();
+ break;
+ case 3:
+ hash = (37 * hash) + COMPARISON_FIELD_NUMBER;
+ hash = (53 * hash) + getComparison().hashCode();
+ break;
+ case 0:
+ default:
+ }
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(java.nio.ByteBuffer data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(byte[] data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(java.io.InputStream input)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(com.google.analytics.data.v1alpha.Comparison prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+
+ /**
+ *
+ *
+ * + * Defines an individual comparison. Most requests will include multiple + * comparisons so that the report compares between the comparisons. + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.Comparison} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessage.Builder
+ * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return Whether the name field is set.
+ */
+ public boolean hasName() {
+ return ((bitField0_ & 0x00000001) != 0);
+ }
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return The name.
+ */
+ public java.lang.String getName() {
+ java.lang.Object ref = name_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ name_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return The bytes for name.
+ */
+ public com.google.protobuf.ByteString getNameBytes() {
+ java.lang.Object ref = name_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ name_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @param value The name to set.
+ * @return This builder for chaining.
+ */
+ public Builder setName(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ name_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearName() {
+ name_ = getDefaultInstance().getName();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @param value The bytes for name to set.
+ * @return This builder for chaining.
+ */
+ public Builder setNameBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ name_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.analytics.data.v1alpha.FilterExpression,
+ com.google.analytics.data.v1alpha.FilterExpression.Builder,
+ com.google.analytics.data.v1alpha.FilterExpressionOrBuilder>
+ dimensionFilterBuilder_;
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ *
+ * @return Whether the dimensionFilter field is set.
+ */
+ @java.lang.Override
+ public boolean hasDimensionFilter() {
+ return oneComparisonCase_ == 2;
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ *
+ * @return The dimensionFilter.
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.FilterExpression getDimensionFilter() {
+ if (dimensionFilterBuilder_ == null) {
+ if (oneComparisonCase_ == 2) {
+ return (com.google.analytics.data.v1alpha.FilterExpression) oneComparison_;
+ }
+ return com.google.analytics.data.v1alpha.FilterExpression.getDefaultInstance();
+ } else {
+ if (oneComparisonCase_ == 2) {
+ return dimensionFilterBuilder_.getMessage();
+ }
+ return com.google.analytics.data.v1alpha.FilterExpression.getDefaultInstance();
+ }
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ public Builder setDimensionFilter(com.google.analytics.data.v1alpha.FilterExpression value) {
+ if (dimensionFilterBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ oneComparison_ = value;
+ onChanged();
+ } else {
+ dimensionFilterBuilder_.setMessage(value);
+ }
+ oneComparisonCase_ = 2;
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ public Builder setDimensionFilter(
+ com.google.analytics.data.v1alpha.FilterExpression.Builder builderForValue) {
+ if (dimensionFilterBuilder_ == null) {
+ oneComparison_ = builderForValue.build();
+ onChanged();
+ } else {
+ dimensionFilterBuilder_.setMessage(builderForValue.build());
+ }
+ oneComparisonCase_ = 2;
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ public Builder mergeDimensionFilter(com.google.analytics.data.v1alpha.FilterExpression value) {
+ if (dimensionFilterBuilder_ == null) {
+ if (oneComparisonCase_ == 2
+ && oneComparison_
+ != com.google.analytics.data.v1alpha.FilterExpression.getDefaultInstance()) {
+ oneComparison_ =
+ com.google.analytics.data.v1alpha.FilterExpression.newBuilder(
+ (com.google.analytics.data.v1alpha.FilterExpression) oneComparison_)
+ .mergeFrom(value)
+ .buildPartial();
+ } else {
+ oneComparison_ = value;
+ }
+ onChanged();
+ } else {
+ if (oneComparisonCase_ == 2) {
+ dimensionFilterBuilder_.mergeFrom(value);
+ } else {
+ dimensionFilterBuilder_.setMessage(value);
+ }
+ }
+ oneComparisonCase_ = 2;
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ public Builder clearDimensionFilter() {
+ if (dimensionFilterBuilder_ == null) {
+ if (oneComparisonCase_ == 2) {
+ oneComparisonCase_ = 0;
+ oneComparison_ = null;
+ onChanged();
+ }
+ } else {
+ if (oneComparisonCase_ == 2) {
+ oneComparisonCase_ = 0;
+ oneComparison_ = null;
+ }
+ dimensionFilterBuilder_.clear();
+ }
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ public com.google.analytics.data.v1alpha.FilterExpression.Builder getDimensionFilterBuilder() {
+ return internalGetDimensionFilterFieldBuilder().getBuilder();
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.FilterExpressionOrBuilder
+ getDimensionFilterOrBuilder() {
+ if ((oneComparisonCase_ == 2) && (dimensionFilterBuilder_ != null)) {
+ return dimensionFilterBuilder_.getMessageOrBuilder();
+ } else {
+ if (oneComparisonCase_ == 2) {
+ return (com.google.analytics.data.v1alpha.FilterExpression) oneComparison_;
+ }
+ return com.google.analytics.data.v1alpha.FilterExpression.getDefaultInstance();
+ }
+ }
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ private com.google.protobuf.SingleFieldBuilder<
+ com.google.analytics.data.v1alpha.FilterExpression,
+ com.google.analytics.data.v1alpha.FilterExpression.Builder,
+ com.google.analytics.data.v1alpha.FilterExpressionOrBuilder>
+ internalGetDimensionFilterFieldBuilder() {
+ if (dimensionFilterBuilder_ == null) {
+ if (!(oneComparisonCase_ == 2)) {
+ oneComparison_ = com.google.analytics.data.v1alpha.FilterExpression.getDefaultInstance();
+ }
+ dimensionFilterBuilder_ =
+ new com.google.protobuf.SingleFieldBuilder<
+ com.google.analytics.data.v1alpha.FilterExpression,
+ com.google.analytics.data.v1alpha.FilterExpression.Builder,
+ com.google.analytics.data.v1alpha.FilterExpressionOrBuilder>(
+ (com.google.analytics.data.v1alpha.FilterExpression) oneComparison_,
+ getParentForChildren(),
+ isClean());
+ oneComparison_ = null;
+ }
+ oneComparisonCase_ = 2;
+ onChanged();
+ return dimensionFilterBuilder_;
+ }
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return Whether the comparison field is set.
+ */
+ @java.lang.Override
+ public boolean hasComparison() {
+ return oneComparisonCase_ == 3;
+ }
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return The comparison.
+ */
+ @java.lang.Override
+ public java.lang.String getComparison() {
+ java.lang.Object ref = "";
+ if (oneComparisonCase_ == 3) {
+ ref = oneComparison_;
+ }
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ if (oneComparisonCase_ == 3) {
+ oneComparison_ = s;
+ }
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return The bytes for comparison.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getComparisonBytes() {
+ java.lang.Object ref = "";
+ if (oneComparisonCase_ == 3) {
+ ref = oneComparison_;
+ }
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ if (oneComparisonCase_ == 3) {
+ oneComparison_ = b;
+ }
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @param value The comparison to set.
+ * @return This builder for chaining.
+ */
+ public Builder setComparison(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ oneComparisonCase_ = 3;
+ oneComparison_ = value;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearComparison() {
+ if (oneComparisonCase_ == 3) {
+ oneComparisonCase_ = 0;
+ oneComparison_ = null;
+ onChanged();
+ }
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @param value The bytes for comparison to set.
+ * @return This builder for chaining.
+ */
+ public Builder setComparisonBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ oneComparisonCase_ = 3;
+ oneComparison_ = value;
+ onChanged();
+ return this;
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.analytics.data.v1alpha.Comparison)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.analytics.data.v1alpha.Comparison)
+ private static final com.google.analytics.data.v1alpha.Comparison DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.analytics.data.v1alpha.Comparison();
+ }
+
+ public static com.google.analytics.data.v1alpha.Comparison getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser+ * The metadata for a single comparison. + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.ComparisonMetadata} + */ +@com.google.protobuf.Generated +public final class ComparisonMetadata extends com.google.protobuf.GeneratedMessage + implements + // @@protoc_insertion_point(message_implements:google.analytics.data.v1alpha.ComparisonMetadata) + ComparisonMetadataOrBuilder { + private static final long serialVersionUID = 0L; + + static { + com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion( + com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC, + /* major= */ 4, + /* minor= */ 33, + /* patch= */ 2, + /* suffix= */ "", + "ComparisonMetadata"); + } + + // Use ComparisonMetadata.newBuilder() to construct. + private ComparisonMetadata(com.google.protobuf.GeneratedMessage.Builder builder) { + super(builder); + } + + private ComparisonMetadata() { + apiName_ = ""; + uiName_ = ""; + description_ = ""; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_ComparisonMetadata_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_ComparisonMetadata_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.analytics.data.v1alpha.ComparisonMetadata.class, + com.google.analytics.data.v1alpha.ComparisonMetadata.Builder.class); + } + + public static final int API_NAME_FIELD_NUMBER = 1; + + @SuppressWarnings("serial") + private volatile java.lang.Object apiName_ = ""; + + /** + * + * + *
+ * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @return The apiName.
+ */
+ @java.lang.Override
+ public java.lang.String getApiName() {
+ java.lang.Object ref = apiName_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ apiName_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @return The bytes for apiName.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getApiNameBytes() {
+ java.lang.Object ref = apiName_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ apiName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int UI_NAME_FIELD_NUMBER = 2;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object uiName_ = "";
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @return The uiName.
+ */
+ @java.lang.Override
+ public java.lang.String getUiName() {
+ java.lang.Object ref = uiName_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ uiName_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @return The bytes for uiName.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getUiNameBytes() {
+ java.lang.Object ref = uiName_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ uiName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int DESCRIPTION_FIELD_NUMBER = 3;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object description_ = "";
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @return The description.
+ */
+ @java.lang.Override
+ public java.lang.String getDescription() {
+ java.lang.Object ref = description_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ description_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @return The bytes for description.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getDescriptionBytes() {
+ java.lang.Object ref = description_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ description_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(apiName_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 1, apiName_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(uiName_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 2, uiName_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(description_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 3, description_);
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(apiName_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(1, apiName_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(uiName_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(2, uiName_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(description_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(3, description_);
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.analytics.data.v1alpha.ComparisonMetadata)) {
+ return super.equals(obj);
+ }
+ com.google.analytics.data.v1alpha.ComparisonMetadata other =
+ (com.google.analytics.data.v1alpha.ComparisonMetadata) obj;
+
+ if (!getApiName().equals(other.getApiName())) return false;
+ if (!getUiName().equals(other.getUiName())) return false;
+ if (!getDescription().equals(other.getDescription())) return false;
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ hash = (37 * hash) + API_NAME_FIELD_NUMBER;
+ hash = (53 * hash) + getApiName().hashCode();
+ hash = (37 * hash) + UI_NAME_FIELD_NUMBER;
+ hash = (53 * hash) + getUiName().hashCode();
+ hash = (37 * hash) + DESCRIPTION_FIELD_NUMBER;
+ hash = (53 * hash) + getDescription().hashCode();
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(byte[] data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(com.google.analytics.data.v1alpha.ComparisonMetadata prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+
+ /**
+ *
+ *
+ * + * The metadata for a single comparison. + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.ComparisonMetadata} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessage.Builder
+ * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @return The apiName.
+ */
+ public java.lang.String getApiName() {
+ java.lang.Object ref = apiName_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ apiName_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @return The bytes for apiName.
+ */
+ public com.google.protobuf.ByteString getApiNameBytes() {
+ java.lang.Object ref = apiName_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ apiName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @param value The apiName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setApiName(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ apiName_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearApiName() {
+ apiName_ = getDefaultInstance().getApiName();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @param value The bytes for apiName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setApiNameBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ apiName_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private java.lang.Object uiName_ = "";
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @return The uiName.
+ */
+ public java.lang.String getUiName() {
+ java.lang.Object ref = uiName_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ uiName_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @return The bytes for uiName.
+ */
+ public com.google.protobuf.ByteString getUiNameBytes() {
+ java.lang.Object ref = uiName_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ uiName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @param value The uiName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setUiName(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ uiName_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearUiName() {
+ uiName_ = getDefaultInstance().getUiName();
+ bitField0_ = (bitField0_ & ~0x00000002);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @param value The bytes for uiName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setUiNameBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ uiName_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ private java.lang.Object description_ = "";
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @return The description.
+ */
+ public java.lang.String getDescription() {
+ java.lang.Object ref = description_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ description_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @return The bytes for description.
+ */
+ public com.google.protobuf.ByteString getDescriptionBytes() {
+ java.lang.Object ref = description_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ description_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @param value The description to set.
+ * @return This builder for chaining.
+ */
+ public Builder setDescription(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ description_ = value;
+ bitField0_ |= 0x00000004;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearDescription() {
+ description_ = getDefaultInstance().getDescription();
+ bitField0_ = (bitField0_ & ~0x00000004);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @param value The bytes for description to set.
+ * @return This builder for chaining.
+ */
+ public Builder setDescriptionBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ description_ = value;
+ bitField0_ |= 0x00000004;
+ onChanged();
+ return this;
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.analytics.data.v1alpha.ComparisonMetadata)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.analytics.data.v1alpha.ComparisonMetadata)
+ private static final com.google.analytics.data.v1alpha.ComparisonMetadata DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.analytics.data.v1alpha.ComparisonMetadata();
+ }
+
+ public static com.google.analytics.data.v1alpha.ComparisonMetadata getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser+ * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @return The apiName.
+ */
+ java.lang.String getApiName();
+
+ /**
+ *
+ *
+ * + * This comparison's resource name. Usable in [Comparison](#Comparison)'s + * `comparison` field. For example, 'comparisons/1234'. + *+ * + *
string api_name = 1;
+ *
+ * @return The bytes for apiName.
+ */
+ com.google.protobuf.ByteString getApiNameBytes();
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @return The uiName.
+ */
+ java.lang.String getUiName();
+
+ /**
+ *
+ *
+ * + * This comparison's name within the Google Analytics user interface. + *+ * + *
string ui_name = 2;
+ *
+ * @return The bytes for uiName.
+ */
+ com.google.protobuf.ByteString getUiNameBytes();
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @return The description.
+ */
+ java.lang.String getDescription();
+
+ /**
+ *
+ *
+ * + * This comparison's description. + *+ * + *
string description = 3;
+ *
+ * @return The bytes for description.
+ */
+ com.google.protobuf.ByteString getDescriptionBytes();
+}
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ComparisonOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ComparisonOrBuilder.java
new file mode 100644
index 000000000000..715420c41445
--- /dev/null
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ComparisonOrBuilder.java
@@ -0,0 +1,154 @@
+/*
+ * Copyright 2026 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!
+// NO CHECKED-IN PROTOBUF GENCODE
+// source: google/analytics/data/v1alpha/data.proto
+// Protobuf Java Version: 4.33.2
+
+package com.google.analytics.data.v1alpha;
+
+@com.google.protobuf.Generated
+public interface ComparisonOrBuilder
+ extends
+ // @@protoc_insertion_point(interface_extends:google.analytics.data.v1alpha.Comparison)
+ com.google.protobuf.MessageOrBuilder {
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return Whether the name field is set.
+ */
+ boolean hasName();
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return The name.
+ */
+ java.lang.String getName();
+
+ /**
+ *
+ *
+ * + * Each comparison produces separate rows in the response. In the response, + * this comparison is identified by this name. If name is unspecified, we will + * use the saved comparisons display name. + *+ * + *
optional string name = 1;
+ *
+ * @return The bytes for name.
+ */
+ com.google.protobuf.ByteString getNameBytes();
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ *
+ * @return Whether the dimensionFilter field is set.
+ */
+ boolean hasDimensionFilter();
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ *
+ * @return The dimensionFilter.
+ */
+ com.google.analytics.data.v1alpha.FilterExpression getDimensionFilter();
+
+ /**
+ *
+ *
+ * + * A basic comparison. + *+ * + *
.google.analytics.data.v1alpha.FilterExpression dimension_filter = 2;
+ */
+ com.google.analytics.data.v1alpha.FilterExpressionOrBuilder getDimensionFilterOrBuilder();
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return Whether the comparison field is set.
+ */
+ boolean hasComparison();
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return The comparison.
+ */
+ java.lang.String getComparison();
+
+ /**
+ *
+ *
+ * + * A saved comparison identified by the comparison's resource name. + * For example, 'comparisons/1234'. + *+ * + *
string comparison = 3;
+ *
+ * @return The bytes for comparison.
+ */
+ com.google.protobuf.ByteString getComparisonBytes();
+
+ com.google.analytics.data.v1alpha.Comparison.OneComparisonCase getOneComparisonCase();
+}
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ConversionMetadata.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ConversionMetadata.java
new file mode 100644
index 000000000000..0c605571405c
--- /dev/null
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ConversionMetadata.java
@@ -0,0 +1,822 @@
+/*
+ * Copyright 2026 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!
+// NO CHECKED-IN PROTOBUF GENCODE
+// source: google/analytics/data/v1alpha/data.proto
+// Protobuf Java Version: 4.33.2
+
+package com.google.analytics.data.v1alpha;
+
+/**
+ *
+ *
+ * + * The metadata for a single conversion. + * + * <aside class="caution"> + * This feature may not be available to your Google Analytics property. The + * Google Analytics team is actively working to expand this feature to more + * properties. Please reach out to your + * <a href="https://support.google.com/analytics/gethelp">support team</a> if + * you have questions about the eligibility of your property. + * </aside> + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.ConversionMetadata} + */ +@com.google.protobuf.Generated +public final class ConversionMetadata extends com.google.protobuf.GeneratedMessage + implements + // @@protoc_insertion_point(message_implements:google.analytics.data.v1alpha.ConversionMetadata) + ConversionMetadataOrBuilder { + private static final long serialVersionUID = 0L; + + static { + com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion( + com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC, + /* major= */ 4, + /* minor= */ 33, + /* patch= */ 2, + /* suffix= */ "", + "ConversionMetadata"); + } + + // Use ConversionMetadata.newBuilder() to construct. + private ConversionMetadata(com.google.protobuf.GeneratedMessage.Builder builder) { + super(builder); + } + + private ConversionMetadata() { + conversionAction_ = ""; + displayName_ = ""; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_ConversionMetadata_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_ConversionMetadata_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.analytics.data.v1alpha.ConversionMetadata.class, + com.google.analytics.data.v1alpha.ConversionMetadata.Builder.class); + } + + public static final int CONVERSION_ACTION_FIELD_NUMBER = 1; + + @SuppressWarnings("serial") + private volatile java.lang.Object conversionAction_ = ""; + + /** + * + * + *
+ * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @return The conversionAction.
+ */
+ @java.lang.Override
+ public java.lang.String getConversionAction() {
+ java.lang.Object ref = conversionAction_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ conversionAction_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @return The bytes for conversionAction.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getConversionActionBytes() {
+ java.lang.Object ref = conversionAction_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ conversionAction_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int DISPLAY_NAME_FIELD_NUMBER = 2;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object displayName_ = "";
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @return The displayName.
+ */
+ @java.lang.Override
+ public java.lang.String getDisplayName() {
+ java.lang.Object ref = displayName_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ displayName_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @return The bytes for displayName.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getDisplayNameBytes() {
+ java.lang.Object ref = displayName_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ displayName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(conversionAction_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 1, conversionAction_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(displayName_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 2, displayName_);
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(conversionAction_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(1, conversionAction_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(displayName_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(2, displayName_);
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.analytics.data.v1alpha.ConversionMetadata)) {
+ return super.equals(obj);
+ }
+ com.google.analytics.data.v1alpha.ConversionMetadata other =
+ (com.google.analytics.data.v1alpha.ConversionMetadata) obj;
+
+ if (!getConversionAction().equals(other.getConversionAction())) return false;
+ if (!getDisplayName().equals(other.getDisplayName())) return false;
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ hash = (37 * hash) + CONVERSION_ACTION_FIELD_NUMBER;
+ hash = (53 * hash) + getConversionAction().hashCode();
+ hash = (37 * hash) + DISPLAY_NAME_FIELD_NUMBER;
+ hash = (53 * hash) + getDisplayName().hashCode();
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(byte[] data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(com.google.analytics.data.v1alpha.ConversionMetadata prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+
+ /**
+ *
+ *
+ * + * The metadata for a single conversion. + * + * <aside class="caution"> + * This feature may not be available to your Google Analytics property. The + * Google Analytics team is actively working to expand this feature to more + * properties. Please reach out to your + * <a href="https://support.google.com/analytics/gethelp">support team</a> if + * you have questions about the eligibility of your property. + * </aside> + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.ConversionMetadata} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessage.Builder
+ * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @return The conversionAction.
+ */
+ public java.lang.String getConversionAction() {
+ java.lang.Object ref = conversionAction_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ conversionAction_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @return The bytes for conversionAction.
+ */
+ public com.google.protobuf.ByteString getConversionActionBytes() {
+ java.lang.Object ref = conversionAction_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ conversionAction_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @param value The conversionAction to set.
+ * @return This builder for chaining.
+ */
+ public Builder setConversionAction(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ conversionAction_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearConversionAction() {
+ conversionAction_ = getDefaultInstance().getConversionAction();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @param value The bytes for conversionAction to set.
+ * @return This builder for chaining.
+ */
+ public Builder setConversionActionBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ conversionAction_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private java.lang.Object displayName_ = "";
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @return The displayName.
+ */
+ public java.lang.String getDisplayName() {
+ java.lang.Object ref = displayName_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ displayName_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @return The bytes for displayName.
+ */
+ public com.google.protobuf.ByteString getDisplayNameBytes() {
+ java.lang.Object ref = displayName_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ displayName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @param value The displayName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setDisplayName(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ displayName_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearDisplayName() {
+ displayName_ = getDefaultInstance().getDisplayName();
+ bitField0_ = (bitField0_ & ~0x00000002);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @param value The bytes for displayName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setDisplayNameBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ displayName_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.analytics.data.v1alpha.ConversionMetadata)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.analytics.data.v1alpha.ConversionMetadata)
+ private static final com.google.analytics.data.v1alpha.ConversionMetadata DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.analytics.data.v1alpha.ConversionMetadata();
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionMetadata getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser+ * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @return The conversionAction.
+ */
+ java.lang.String getConversionAction();
+
+ /**
+ *
+ *
+ * + * The unique identifier of the conversion action. This ID is used to specify + * which conversions to include in a report by populating the + * `conversion_actions` field in the `ConversionsSpec` of a report request. + * For example, 'conversionActions/1234'. + *+ * + *
string conversion_action = 1;
+ *
+ * @return The bytes for conversionAction.
+ */
+ com.google.protobuf.ByteString getConversionActionBytes();
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @return The displayName.
+ */
+ java.lang.String getDisplayName();
+
+ /**
+ *
+ *
+ * + * This conversion's name within the Google Analytics user interface. + *+ * + *
string display_name = 2;
+ *
+ * @return The bytes for displayName.
+ */
+ com.google.protobuf.ByteString getDisplayNameBytes();
+}
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ConversionSpec.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ConversionSpec.java
new file mode 100644
index 000000000000..e1e1cef112ca
--- /dev/null
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ConversionSpec.java
@@ -0,0 +1,1118 @@
+/*
+ * Copyright 2026 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!
+// NO CHECKED-IN PROTOBUF GENCODE
+// source: google/analytics/data/v1alpha/data.proto
+// Protobuf Java Version: 4.33.2
+
+package com.google.analytics.data.v1alpha;
+
+/**
+ *
+ *
+ * + * Controls conversion reporting. + * + * <aside class="caution"> + * This feature may not be available to your Google Analytics property. The + * Google Analytics team is actively working to expand this feature to more + * properties. Please reach out to your + * <a href="https://support.google.com/analytics/gethelp">support team</a> if + * you have questions about the eligibility of your property. + * </aside> + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.ConversionSpec} + */ +@com.google.protobuf.Generated +public final class ConversionSpec extends com.google.protobuf.GeneratedMessage + implements + // @@protoc_insertion_point(message_implements:google.analytics.data.v1alpha.ConversionSpec) + ConversionSpecOrBuilder { + private static final long serialVersionUID = 0L; + + static { + com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion( + com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC, + /* major= */ 4, + /* minor= */ 33, + /* patch= */ 2, + /* suffix= */ "", + "ConversionSpec"); + } + + // Use ConversionSpec.newBuilder() to construct. + private ConversionSpec(com.google.protobuf.GeneratedMessage.Builder builder) { + super(builder); + } + + private ConversionSpec() { + conversionActions_ = com.google.protobuf.LazyStringArrayList.emptyList(); + attributionModel_ = 0; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_ConversionSpec_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_ConversionSpec_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.analytics.data.v1alpha.ConversionSpec.class, + com.google.analytics.data.v1alpha.ConversionSpec.Builder.class); + } + + /** + * + * + *
+ * Attribution model to use in the Conversion Report + *+ * + * Protobuf enum {@code google.analytics.data.v1alpha.ConversionSpec.AttributionModel} + */ + public enum AttributionModel implements com.google.protobuf.ProtocolMessageEnum { + /** + * + * + *
+ * Unspecified attribution model. + *+ * + *
ATTRIBUTION_MODEL_UNSPECIFIED = 0;
+ */
+ ATTRIBUTION_MODEL_UNSPECIFIED(0),
+ /**
+ *
+ *
+ * + * Attribution was based on the paid and organic data driven model + *+ * + *
DATA_DRIVEN = 1;
+ */
+ DATA_DRIVEN(1),
+ /**
+ *
+ *
+ * + * Attribution was based on the paid and organic last click model + *+ * + *
LAST_CLICK = 2;
+ */
+ LAST_CLICK(2),
+ UNRECOGNIZED(-1),
+ ;
+
+ static {
+ com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion(
+ com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC,
+ /* major= */ 4,
+ /* minor= */ 33,
+ /* patch= */ 2,
+ /* suffix= */ "",
+ "AttributionModel");
+ }
+
+ /**
+ *
+ *
+ * + * Unspecified attribution model. + *+ * + *
ATTRIBUTION_MODEL_UNSPECIFIED = 0;
+ */
+ public static final int ATTRIBUTION_MODEL_UNSPECIFIED_VALUE = 0;
+
+ /**
+ *
+ *
+ * + * Attribution was based on the paid and organic data driven model + *+ * + *
DATA_DRIVEN = 1;
+ */
+ public static final int DATA_DRIVEN_VALUE = 1;
+
+ /**
+ *
+ *
+ * + * Attribution was based on the paid and organic last click model + *+ * + *
LAST_CLICK = 2;
+ */
+ public static final int LAST_CLICK_VALUE = 2;
+
+ public final int getNumber() {
+ if (this == UNRECOGNIZED) {
+ throw new java.lang.IllegalArgumentException(
+ "Can't get the number of an unknown enum value.");
+ }
+ return value;
+ }
+
+ /**
+ * @param value The numeric wire value of the corresponding enum entry.
+ * @return The enum associated with the given numeric wire value.
+ * @deprecated Use {@link #forNumber(int)} instead.
+ */
+ @java.lang.Deprecated
+ public static AttributionModel valueOf(int value) {
+ return forNumber(value);
+ }
+
+ /**
+ * @param value The numeric wire value of the corresponding enum entry.
+ * @return The enum associated with the given numeric wire value.
+ */
+ public static AttributionModel forNumber(int value) {
+ switch (value) {
+ case 0:
+ return ATTRIBUTION_MODEL_UNSPECIFIED;
+ case 1:
+ return DATA_DRIVEN;
+ case 2:
+ return LAST_CLICK;
+ default:
+ return null;
+ }
+ }
+
+ public static com.google.protobuf.Internal.EnumLiteMap+ * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @return A list containing the conversionActions.
+ */
+ public com.google.protobuf.ProtocolStringList getConversionActionsList() {
+ return conversionActions_;
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @return The count of conversionActions.
+ */
+ public int getConversionActionsCount() {
+ return conversionActions_.size();
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param index The index of the element to return.
+ * @return The conversionActions at the given index.
+ */
+ public java.lang.String getConversionActions(int index) {
+ return conversionActions_.get(index);
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param index The index of the value to return.
+ * @return The bytes of the conversionActions at the given index.
+ */
+ public com.google.protobuf.ByteString getConversionActionsBytes(int index) {
+ return conversionActions_.getByteString(index);
+ }
+
+ public static final int ATTRIBUTION_MODEL_FIELD_NUMBER = 2;
+ private int attributionModel_ = 0;
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @return The enum numeric value on the wire for attributionModel.
+ */
+ @java.lang.Override
+ public int getAttributionModelValue() {
+ return attributionModel_;
+ }
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @return The attributionModel.
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel getAttributionModel() {
+ com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel result =
+ com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel.forNumber(
+ attributionModel_);
+ return result == null
+ ? com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel.UNRECOGNIZED
+ : result;
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ for (int i = 0; i < conversionActions_.size(); i++) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 1, conversionActions_.getRaw(i));
+ }
+ if (attributionModel_
+ != com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel
+ .ATTRIBUTION_MODEL_UNSPECIFIED
+ .getNumber()) {
+ output.writeEnum(2, attributionModel_);
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ {
+ int dataSize = 0;
+ for (int i = 0; i < conversionActions_.size(); i++) {
+ dataSize += computeStringSizeNoTag(conversionActions_.getRaw(i));
+ }
+ size += dataSize;
+ size += 1 * getConversionActionsList().size();
+ }
+ if (attributionModel_
+ != com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel
+ .ATTRIBUTION_MODEL_UNSPECIFIED
+ .getNumber()) {
+ size += com.google.protobuf.CodedOutputStream.computeEnumSize(2, attributionModel_);
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.analytics.data.v1alpha.ConversionSpec)) {
+ return super.equals(obj);
+ }
+ com.google.analytics.data.v1alpha.ConversionSpec other =
+ (com.google.analytics.data.v1alpha.ConversionSpec) obj;
+
+ if (!getConversionActionsList().equals(other.getConversionActionsList())) return false;
+ if (attributionModel_ != other.attributionModel_) return false;
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ if (getConversionActionsCount() > 0) {
+ hash = (37 * hash) + CONVERSION_ACTIONS_FIELD_NUMBER;
+ hash = (53 * hash) + getConversionActionsList().hashCode();
+ }
+ hash = (37 * hash) + ATTRIBUTION_MODEL_FIELD_NUMBER;
+ hash = (53 * hash) + attributionModel_;
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(java.nio.ByteBuffer data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(byte[] data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(com.google.analytics.data.v1alpha.ConversionSpec prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+
+ /**
+ *
+ *
+ * + * Controls conversion reporting. + * + * <aside class="caution"> + * This feature may not be available to your Google Analytics property. The + * Google Analytics team is actively working to expand this feature to more + * properties. Please reach out to your + * <a href="https://support.google.com/analytics/gethelp">support team</a> if + * you have questions about the eligibility of your property. + * </aside> + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.ConversionSpec} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessage.Builder
+ * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @return A list containing the conversionActions.
+ */
+ public com.google.protobuf.ProtocolStringList getConversionActionsList() {
+ conversionActions_.makeImmutable();
+ return conversionActions_;
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @return The count of conversionActions.
+ */
+ public int getConversionActionsCount() {
+ return conversionActions_.size();
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param index The index of the element to return.
+ * @return The conversionActions at the given index.
+ */
+ public java.lang.String getConversionActions(int index) {
+ return conversionActions_.get(index);
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param index The index of the value to return.
+ * @return The bytes of the conversionActions at the given index.
+ */
+ public com.google.protobuf.ByteString getConversionActionsBytes(int index) {
+ return conversionActions_.getByteString(index);
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param index The index to set the value at.
+ * @param value The conversionActions to set.
+ * @return This builder for chaining.
+ */
+ public Builder setConversionActions(int index, java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ ensureConversionActionsIsMutable();
+ conversionActions_.set(index, value);
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param value The conversionActions to add.
+ * @return This builder for chaining.
+ */
+ public Builder addConversionActions(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ ensureConversionActionsIsMutable();
+ conversionActions_.add(value);
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param values The conversionActions to add.
+ * @return This builder for chaining.
+ */
+ public Builder addAllConversionActions(java.lang.Iterable+ * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearConversionActions() {
+ conversionActions_ = com.google.protobuf.LazyStringArrayList.emptyList();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ ;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param value The bytes of the conversionActions to add.
+ * @return This builder for chaining.
+ */
+ public Builder addConversionActionsBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ ensureConversionActionsIsMutable();
+ conversionActions_.add(value);
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private int attributionModel_ = 0;
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @return The enum numeric value on the wire for attributionModel.
+ */
+ @java.lang.Override
+ public int getAttributionModelValue() {
+ return attributionModel_;
+ }
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @param value The enum numeric value on the wire for attributionModel to set.
+ * @return This builder for chaining.
+ */
+ public Builder setAttributionModelValue(int value) {
+ attributionModel_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @return The attributionModel.
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel getAttributionModel() {
+ com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel result =
+ com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel.forNumber(
+ attributionModel_);
+ return result == null
+ ? com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel.UNRECOGNIZED
+ : result;
+ }
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @param value The attributionModel to set.
+ * @return This builder for chaining.
+ */
+ public Builder setAttributionModel(
+ com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ bitField0_ |= 0x00000002;
+ attributionModel_ = value.getNumber();
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearAttributionModel() {
+ bitField0_ = (bitField0_ & ~0x00000002);
+ attributionModel_ = 0;
+ onChanged();
+ return this;
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.analytics.data.v1alpha.ConversionSpec)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.analytics.data.v1alpha.ConversionSpec)
+ private static final com.google.analytics.data.v1alpha.ConversionSpec DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.analytics.data.v1alpha.ConversionSpec();
+ }
+
+ public static com.google.analytics.data.v1alpha.ConversionSpec getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser+ * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @return A list containing the conversionActions.
+ */
+ java.util.List+ * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @return The count of conversionActions.
+ */
+ int getConversionActionsCount();
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param index The index of the element to return.
+ * @return The conversionActions at the given index.
+ */
+ java.lang.String getConversionActions(int index);
+
+ /**
+ *
+ *
+ * + * The conversion action IDs to include in the report. If empty, all + * conversions are included. Valid conversion action IDs can be retrieved from + * the `conversion_action` field within the `conversions` list in the + * response of the `GetMetadata` method. For example, + * 'conversionActions/1234'. + *+ * + *
repeated string conversion_actions = 1;
+ *
+ * @param index The index of the value to return.
+ * @return The bytes of the conversionActions at the given index.
+ */
+ com.google.protobuf.ByteString getConversionActionsBytes(int index);
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @return The enum numeric value on the wire for attributionModel.
+ */
+ int getAttributionModelValue();
+
+ /**
+ *
+ *
+ * + * The attribution model to use in the Conversion Report. If unspecified, + * `DATA_DRIVEN` is used. + *+ * + *
.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;
+ *
+ *
+ * @return The attributionModel.
+ */
+ com.google.analytics.data.v1alpha.ConversionSpec.AttributionModel getAttributionModel();
+}
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DimensionMetadata.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DimensionMetadata.java
new file mode 100644
index 000000000000..3b5fdb3fec97
--- /dev/null
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DimensionMetadata.java
@@ -0,0 +1,2023 @@
+/*
+ * Copyright 2026 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!
+// NO CHECKED-IN PROTOBUF GENCODE
+// source: google/analytics/data/v1alpha/data.proto
+// Protobuf Java Version: 4.33.2
+
+package com.google.analytics.data.v1alpha;
+
+/**
+ *
+ *
+ * + * Explains a dimension. + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.DimensionMetadata} + */ +@com.google.protobuf.Generated +public final class DimensionMetadata extends com.google.protobuf.GeneratedMessage + implements + // @@protoc_insertion_point(message_implements:google.analytics.data.v1alpha.DimensionMetadata) + DimensionMetadataOrBuilder { + private static final long serialVersionUID = 0L; + + static { + com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion( + com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC, + /* major= */ 4, + /* minor= */ 33, + /* patch= */ 2, + /* suffix= */ "", + "DimensionMetadata"); + } + + // Use DimensionMetadata.newBuilder() to construct. + private DimensionMetadata(com.google.protobuf.GeneratedMessage.Builder builder) { + super(builder); + } + + private DimensionMetadata() { + apiName_ = ""; + uiName_ = ""; + description_ = ""; + deprecatedApiNames_ = com.google.protobuf.LazyStringArrayList.emptyList(); + category_ = ""; + sections_ = emptyIntList(); + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_DimensionMetadata_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.analytics.data.v1alpha.ReportingApiProto + .internal_static_google_analytics_data_v1alpha_DimensionMetadata_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.analytics.data.v1alpha.DimensionMetadata.class, + com.google.analytics.data.v1alpha.DimensionMetadata.Builder.class); + } + + public static final int API_NAME_FIELD_NUMBER = 1; + + @SuppressWarnings("serial") + private volatile java.lang.Object apiName_ = ""; + + /** + * + * + *
+ * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @return The apiName.
+ */
+ @java.lang.Override
+ public java.lang.String getApiName() {
+ java.lang.Object ref = apiName_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ apiName_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @return The bytes for apiName.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getApiNameBytes() {
+ java.lang.Object ref = apiName_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ apiName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int UI_NAME_FIELD_NUMBER = 2;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object uiName_ = "";
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @return The uiName.
+ */
+ @java.lang.Override
+ public java.lang.String getUiName() {
+ java.lang.Object ref = uiName_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ uiName_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @return The bytes for uiName.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getUiNameBytes() {
+ java.lang.Object ref = uiName_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ uiName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int DESCRIPTION_FIELD_NUMBER = 3;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object description_ = "";
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @return The description.
+ */
+ @java.lang.Override
+ public java.lang.String getDescription() {
+ java.lang.Object ref = description_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ description_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @return The bytes for description.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getDescriptionBytes() {
+ java.lang.Object ref = description_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ description_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int DEPRECATED_API_NAMES_FIELD_NUMBER = 4;
+
+ @SuppressWarnings("serial")
+ private com.google.protobuf.LazyStringArrayList deprecatedApiNames_ =
+ com.google.protobuf.LazyStringArrayList.emptyList();
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @return A list containing the deprecatedApiNames.
+ */
+ public com.google.protobuf.ProtocolStringList getDeprecatedApiNamesList() {
+ return deprecatedApiNames_;
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @return The count of deprecatedApiNames.
+ */
+ public int getDeprecatedApiNamesCount() {
+ return deprecatedApiNames_.size();
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param index The index of the element to return.
+ * @return The deprecatedApiNames at the given index.
+ */
+ public java.lang.String getDeprecatedApiNames(int index) {
+ return deprecatedApiNames_.get(index);
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param index The index of the value to return.
+ * @return The bytes of the deprecatedApiNames at the given index.
+ */
+ public com.google.protobuf.ByteString getDeprecatedApiNamesBytes(int index) {
+ return deprecatedApiNames_.getByteString(index);
+ }
+
+ public static final int CUSTOM_DEFINITION_FIELD_NUMBER = 5;
+ private boolean customDefinition_ = false;
+
+ /**
+ *
+ *
+ * + * True if the dimension is custom to this property. This includes user, + * event, & item scoped custom dimensions; to learn more about custom + * dimensions, see https://support.google.com/analytics/answer/14240153. This + * also include custom channel groups; to learn more about custom channel + * groups, see https://support.google.com/analytics/answer/13051316. + *+ * + *
bool custom_definition = 5;
+ *
+ * @return The customDefinition.
+ */
+ @java.lang.Override
+ public boolean getCustomDefinition() {
+ return customDefinition_;
+ }
+
+ public static final int CATEGORY_FIELD_NUMBER = 6;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object category_ = "";
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @return The category.
+ */
+ @java.lang.Override
+ public java.lang.String getCategory() {
+ java.lang.Object ref = category_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ category_ = s;
+ return s;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @return The bytes for category.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getCategoryBytes() {
+ java.lang.Object ref = category_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ category_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int SECTIONS_FIELD_NUMBER = 7;
+
+ @SuppressWarnings("serial")
+ private com.google.protobuf.Internal.IntList sections_ = emptyIntList();
+
+ private static final com.google.protobuf.Internal.IntListAdapter.IntConverter<
+ com.google.analytics.data.v1alpha.Section>
+ sections_converter_ =
+ new com.google.protobuf.Internal.IntListAdapter.IntConverter<
+ com.google.analytics.data.v1alpha.Section>() {
+ public com.google.analytics.data.v1alpha.Section convert(int from) {
+ com.google.analytics.data.v1alpha.Section result =
+ com.google.analytics.data.v1alpha.Section.forNumber(from);
+ return result == null
+ ? com.google.analytics.data.v1alpha.Section.UNRECOGNIZED
+ : result;
+ }
+ };
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @return A list containing the sections.
+ */
+ @java.lang.Override
+ public java.util.List+ * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @return The count of sections.
+ */
+ @java.lang.Override
+ public int getSectionsCount() {
+ return sections_.size();
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param index The index of the element to return.
+ * @return The sections at the given index.
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.Section getSections(int index) {
+ return sections_converter_.convert(sections_.getInt(index));
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @return A list containing the enum numeric values on the wire for sections.
+ */
+ @java.lang.Override
+ public java.util.List+ * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param index The index of the value to return.
+ * @return The enum numeric value on the wire of sections at the given index.
+ */
+ @java.lang.Override
+ public int getSectionsValue(int index) {
+ return sections_.getInt(index);
+ }
+
+ private int sectionsMemoizedSerializedSize;
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ getSerializedSize();
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(apiName_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 1, apiName_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(uiName_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 2, uiName_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(description_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 3, description_);
+ }
+ for (int i = 0; i < deprecatedApiNames_.size(); i++) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 4, deprecatedApiNames_.getRaw(i));
+ }
+ if (customDefinition_ != false) {
+ output.writeBool(5, customDefinition_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(category_)) {
+ com.google.protobuf.GeneratedMessage.writeString(output, 6, category_);
+ }
+ if (getSectionsList().size() > 0) {
+ output.writeUInt32NoTag(58);
+ output.writeUInt32NoTag(sectionsMemoizedSerializedSize);
+ }
+ for (int i = 0; i < sections_.size(); i++) {
+ output.writeEnumNoTag(sections_.getInt(i));
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(apiName_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(1, apiName_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(uiName_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(2, uiName_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(description_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(3, description_);
+ }
+ {
+ int dataSize = 0;
+ for (int i = 0; i < deprecatedApiNames_.size(); i++) {
+ dataSize += computeStringSizeNoTag(deprecatedApiNames_.getRaw(i));
+ }
+ size += dataSize;
+ size += 1 * getDeprecatedApiNamesList().size();
+ }
+ if (customDefinition_ != false) {
+ size += com.google.protobuf.CodedOutputStream.computeBoolSize(5, customDefinition_);
+ }
+ if (!com.google.protobuf.GeneratedMessage.isStringEmpty(category_)) {
+ size += com.google.protobuf.GeneratedMessage.computeStringSize(6, category_);
+ }
+ {
+ int dataSize = 0;
+ for (int i = 0; i < sections_.size(); i++) {
+ dataSize += com.google.protobuf.CodedOutputStream.computeEnumSizeNoTag(sections_.getInt(i));
+ }
+ size += dataSize;
+ if (!getSectionsList().isEmpty()) {
+ size += 1;
+ size += com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(dataSize);
+ }
+ sectionsMemoizedSerializedSize = dataSize;
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.analytics.data.v1alpha.DimensionMetadata)) {
+ return super.equals(obj);
+ }
+ com.google.analytics.data.v1alpha.DimensionMetadata other =
+ (com.google.analytics.data.v1alpha.DimensionMetadata) obj;
+
+ if (!getApiName().equals(other.getApiName())) return false;
+ if (!getUiName().equals(other.getUiName())) return false;
+ if (!getDescription().equals(other.getDescription())) return false;
+ if (!getDeprecatedApiNamesList().equals(other.getDeprecatedApiNamesList())) return false;
+ if (getCustomDefinition() != other.getCustomDefinition()) return false;
+ if (!getCategory().equals(other.getCategory())) return false;
+ if (!sections_.equals(other.sections_)) return false;
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ hash = (37 * hash) + API_NAME_FIELD_NUMBER;
+ hash = (53 * hash) + getApiName().hashCode();
+ hash = (37 * hash) + UI_NAME_FIELD_NUMBER;
+ hash = (53 * hash) + getUiName().hashCode();
+ hash = (37 * hash) + DESCRIPTION_FIELD_NUMBER;
+ hash = (53 * hash) + getDescription().hashCode();
+ if (getDeprecatedApiNamesCount() > 0) {
+ hash = (37 * hash) + DEPRECATED_API_NAMES_FIELD_NUMBER;
+ hash = (53 * hash) + getDeprecatedApiNamesList().hashCode();
+ }
+ hash = (37 * hash) + CUSTOM_DEFINITION_FIELD_NUMBER;
+ hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(getCustomDefinition());
+ hash = (37 * hash) + CATEGORY_FIELD_NUMBER;
+ hash = (53 * hash) + getCategory().hashCode();
+ if (getSectionsCount() > 0) {
+ hash = (37 * hash) + SECTIONS_FIELD_NUMBER;
+ hash = (53 * hash) + sections_.hashCode();
+ }
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(byte[] data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.DimensionMetadata parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessage.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(com.google.analytics.data.v1alpha.DimensionMetadata prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+
+ /**
+ *
+ *
+ * + * Explains a dimension. + *+ * + * Protobuf type {@code google.analytics.data.v1alpha.DimensionMetadata} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessage.Builder
+ * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @return The apiName.
+ */
+ public java.lang.String getApiName() {
+ java.lang.Object ref = apiName_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ apiName_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @return The bytes for apiName.
+ */
+ public com.google.protobuf.ByteString getApiNameBytes() {
+ java.lang.Object ref = apiName_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ apiName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @param value The apiName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setApiName(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ apiName_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearApiName() {
+ apiName_ = getDefaultInstance().getApiName();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @param value The bytes for apiName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setApiNameBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ apiName_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private java.lang.Object uiName_ = "";
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @return The uiName.
+ */
+ public java.lang.String getUiName() {
+ java.lang.Object ref = uiName_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ uiName_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @return The bytes for uiName.
+ */
+ public com.google.protobuf.ByteString getUiNameBytes() {
+ java.lang.Object ref = uiName_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ uiName_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @param value The uiName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setUiName(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ uiName_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearUiName() {
+ uiName_ = getDefaultInstance().getUiName();
+ bitField0_ = (bitField0_ & ~0x00000002);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @param value The bytes for uiName to set.
+ * @return This builder for chaining.
+ */
+ public Builder setUiNameBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ uiName_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ private java.lang.Object description_ = "";
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @return The description.
+ */
+ public java.lang.String getDescription() {
+ java.lang.Object ref = description_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ description_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @return The bytes for description.
+ */
+ public com.google.protobuf.ByteString getDescriptionBytes() {
+ java.lang.Object ref = description_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ description_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @param value The description to set.
+ * @return This builder for chaining.
+ */
+ public Builder setDescription(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ description_ = value;
+ bitField0_ |= 0x00000004;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearDescription() {
+ description_ = getDefaultInstance().getDescription();
+ bitField0_ = (bitField0_ & ~0x00000004);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @param value The bytes for description to set.
+ * @return This builder for chaining.
+ */
+ public Builder setDescriptionBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ description_ = value;
+ bitField0_ |= 0x00000004;
+ onChanged();
+ return this;
+ }
+
+ private com.google.protobuf.LazyStringArrayList deprecatedApiNames_ =
+ com.google.protobuf.LazyStringArrayList.emptyList();
+
+ private void ensureDeprecatedApiNamesIsMutable() {
+ if (!deprecatedApiNames_.isModifiable()) {
+ deprecatedApiNames_ = new com.google.protobuf.LazyStringArrayList(deprecatedApiNames_);
+ }
+ bitField0_ |= 0x00000008;
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @return A list containing the deprecatedApiNames.
+ */
+ public com.google.protobuf.ProtocolStringList getDeprecatedApiNamesList() {
+ deprecatedApiNames_.makeImmutable();
+ return deprecatedApiNames_;
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @return The count of deprecatedApiNames.
+ */
+ public int getDeprecatedApiNamesCount() {
+ return deprecatedApiNames_.size();
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param index The index of the element to return.
+ * @return The deprecatedApiNames at the given index.
+ */
+ public java.lang.String getDeprecatedApiNames(int index) {
+ return deprecatedApiNames_.get(index);
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param index The index of the value to return.
+ * @return The bytes of the deprecatedApiNames at the given index.
+ */
+ public com.google.protobuf.ByteString getDeprecatedApiNamesBytes(int index) {
+ return deprecatedApiNames_.getByteString(index);
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param index The index to set the value at.
+ * @param value The deprecatedApiNames to set.
+ * @return This builder for chaining.
+ */
+ public Builder setDeprecatedApiNames(int index, java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ ensureDeprecatedApiNamesIsMutable();
+ deprecatedApiNames_.set(index, value);
+ bitField0_ |= 0x00000008;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param value The deprecatedApiNames to add.
+ * @return This builder for chaining.
+ */
+ public Builder addDeprecatedApiNames(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ ensureDeprecatedApiNamesIsMutable();
+ deprecatedApiNames_.add(value);
+ bitField0_ |= 0x00000008;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param values The deprecatedApiNames to add.
+ * @return This builder for chaining.
+ */
+ public Builder addAllDeprecatedApiNames(java.lang.Iterable+ * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearDeprecatedApiNames() {
+ deprecatedApiNames_ = com.google.protobuf.LazyStringArrayList.emptyList();
+ bitField0_ = (bitField0_ & ~0x00000008);
+ ;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param value The bytes of the deprecatedApiNames to add.
+ * @return This builder for chaining.
+ */
+ public Builder addDeprecatedApiNamesBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ ensureDeprecatedApiNamesIsMutable();
+ deprecatedApiNames_.add(value);
+ bitField0_ |= 0x00000008;
+ onChanged();
+ return this;
+ }
+
+ private boolean customDefinition_;
+
+ /**
+ *
+ *
+ * + * True if the dimension is custom to this property. This includes user, + * event, & item scoped custom dimensions; to learn more about custom + * dimensions, see https://support.google.com/analytics/answer/14240153. This + * also include custom channel groups; to learn more about custom channel + * groups, see https://support.google.com/analytics/answer/13051316. + *+ * + *
bool custom_definition = 5;
+ *
+ * @return The customDefinition.
+ */
+ @java.lang.Override
+ public boolean getCustomDefinition() {
+ return customDefinition_;
+ }
+
+ /**
+ *
+ *
+ * + * True if the dimension is custom to this property. This includes user, + * event, & item scoped custom dimensions; to learn more about custom + * dimensions, see https://support.google.com/analytics/answer/14240153. This + * also include custom channel groups; to learn more about custom channel + * groups, see https://support.google.com/analytics/answer/13051316. + *+ * + *
bool custom_definition = 5;
+ *
+ * @param value The customDefinition to set.
+ * @return This builder for chaining.
+ */
+ public Builder setCustomDefinition(boolean value) {
+
+ customDefinition_ = value;
+ bitField0_ |= 0x00000010;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * True if the dimension is custom to this property. This includes user, + * event, & item scoped custom dimensions; to learn more about custom + * dimensions, see https://support.google.com/analytics/answer/14240153. This + * also include custom channel groups; to learn more about custom channel + * groups, see https://support.google.com/analytics/answer/13051316. + *+ * + *
bool custom_definition = 5;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearCustomDefinition() {
+ bitField0_ = (bitField0_ & ~0x00000010);
+ customDefinition_ = false;
+ onChanged();
+ return this;
+ }
+
+ private java.lang.Object category_ = "";
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @return The category.
+ */
+ public java.lang.String getCategory() {
+ java.lang.Object ref = category_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ category_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @return The bytes for category.
+ */
+ public com.google.protobuf.ByteString getCategoryBytes() {
+ java.lang.Object ref = category_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ category_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @param value The category to set.
+ * @return This builder for chaining.
+ */
+ public Builder setCategory(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ category_ = value;
+ bitField0_ |= 0x00000020;
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearCategory() {
+ category_ = getDefaultInstance().getCategory();
+ bitField0_ = (bitField0_ & ~0x00000020);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @param value The bytes for category to set.
+ * @return This builder for chaining.
+ */
+ public Builder setCategoryBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ category_ = value;
+ bitField0_ |= 0x00000020;
+ onChanged();
+ return this;
+ }
+
+ private com.google.protobuf.Internal.IntList sections_ = emptyIntList();
+
+ private void ensureSectionsIsMutable() {
+ if (!sections_.isModifiable()) {
+ sections_ = makeMutableCopy(sections_);
+ }
+ bitField0_ |= 0x00000040;
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @return A list containing the sections.
+ */
+ public java.util.List+ * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @return The count of sections.
+ */
+ public int getSectionsCount() {
+ return sections_.size();
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param index The index of the element to return.
+ * @return The sections at the given index.
+ */
+ public com.google.analytics.data.v1alpha.Section getSections(int index) {
+ return sections_converter_.convert(sections_.getInt(index));
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param index The index to set the value at.
+ * @param value The sections to set.
+ * @return This builder for chaining.
+ */
+ public Builder setSections(int index, com.google.analytics.data.v1alpha.Section value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ ensureSectionsIsMutable();
+ sections_.setInt(index, value.getNumber());
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param value The sections to add.
+ * @return This builder for chaining.
+ */
+ public Builder addSections(com.google.analytics.data.v1alpha.Section value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ ensureSectionsIsMutable();
+ sections_.addInt(value.getNumber());
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param values The sections to add.
+ * @return This builder for chaining.
+ */
+ public Builder addAllSections(
+ java.lang.Iterable values) {
+ ensureSectionsIsMutable();
+ for (com.google.analytics.data.v1alpha.Section value : values) {
+ sections_.addInt(value.getNumber());
+ }
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearSections() {
+ sections_ = emptyIntList();
+ bitField0_ = (bitField0_ & ~0x00000040);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @return A list containing the enum numeric values on the wire for sections.
+ */
+ public java.util.List+ * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param index The index of the value to return.
+ * @return The enum numeric value on the wire of sections at the given index.
+ */
+ public int getSectionsValue(int index) {
+ return sections_.getInt(index);
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param index The index to set the value at.
+ * @param value The enum numeric value on the wire for sections to set.
+ * @return This builder for chaining.
+ */
+ public Builder setSectionsValue(int index, int value) {
+ ensureSectionsIsMutable();
+ sections_.setInt(index, value);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param value The enum numeric value on the wire for sections to add.
+ * @return This builder for chaining.
+ */
+ public Builder addSectionsValue(int value) {
+ ensureSectionsIsMutable();
+ sections_.addInt(value);
+ onChanged();
+ return this;
+ }
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @param values The enum numeric values on the wire for sections to add.
+ * @return This builder for chaining.
+ */
+ public Builder addAllSectionsValue(java.lang.Iterable+ * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @return The apiName.
+ */
+ java.lang.String getApiName();
+
+ /**
+ *
+ *
+ * + * This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For + * example, `eventName`. + *+ * + *
string api_name = 1;
+ *
+ * @return The bytes for apiName.
+ */
+ com.google.protobuf.ByteString getApiNameBytes();
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @return The uiName.
+ */
+ java.lang.String getUiName();
+
+ /**
+ *
+ *
+ * + * This dimension's name within the Google Analytics user interface. For + * example, `Event name`. + *+ * + *
string ui_name = 2;
+ *
+ * @return The bytes for uiName.
+ */
+ com.google.protobuf.ByteString getUiNameBytes();
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @return The description.
+ */
+ java.lang.String getDescription();
+
+ /**
+ *
+ *
+ * + * Description of how this dimension is used and calculated. + *+ * + *
string description = 3;
+ *
+ * @return The bytes for description.
+ */
+ com.google.protobuf.ByteString getDescriptionBytes();
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @return A list containing the deprecatedApiNames.
+ */
+ java.util.List+ * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @return The count of deprecatedApiNames.
+ */
+ int getDeprecatedApiNamesCount();
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param index The index of the element to return.
+ * @return The deprecatedApiNames at the given index.
+ */
+ java.lang.String getDeprecatedApiNames(int index);
+
+ /**
+ *
+ *
+ * + * Still usable but deprecated names for this dimension. If populated, this + * dimension is available by either `apiName` or one of `deprecatedApiNames` + * for a period of time. After the deprecation period, the dimension will be + * available only by `apiName`. + *+ * + *
repeated string deprecated_api_names = 4;
+ *
+ * @param index The index of the value to return.
+ * @return The bytes of the deprecatedApiNames at the given index.
+ */
+ com.google.protobuf.ByteString getDeprecatedApiNamesBytes(int index);
+
+ /**
+ *
+ *
+ * + * True if the dimension is custom to this property. This includes user, + * event, & item scoped custom dimensions; to learn more about custom + * dimensions, see https://support.google.com/analytics/answer/14240153. This + * also include custom channel groups; to learn more about custom channel + * groups, see https://support.google.com/analytics/answer/13051316. + *+ * + *
bool custom_definition = 5;
+ *
+ * @return The customDefinition.
+ */
+ boolean getCustomDefinition();
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @return The category.
+ */
+ java.lang.String getCategory();
+
+ /**
+ *
+ *
+ * + * The display name of the category that this dimension belongs to. Similar + * dimensions and metrics are categorized together. + *+ * + *
string category = 6;
+ *
+ * @return The bytes for category.
+ */
+ com.google.protobuf.ByteString getCategoryBytes();
+
+ /**
+ *
+ *
+ * + * Specifies the Google Analytics sections this dimension applies to. + *+ * + *
repeated .google.analytics.data.v1alpha.Section sections = 7;
+ *
+ * @return A list containing the sections.
+ */
+ java.util.List