com.google.cloud.retail.v2

Class ExportAnalyticsMetricsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

com.google.cloud.retail.v2.ExportAnalyticsMetricsRequest.Builder

All Implemented Interfaces:

ExportAnalyticsMetricsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ExportAnalyticsMetricsRequest

public static final class ExportAnalyticsMetricsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>
implements ExportAnalyticsMetricsRequestOrBuilder

 Request message for the `ExportAnalyticsMetrics` method.
 

Protobuf type google.cloud.retail.v2.ExportAnalyticsMetricsRequest

Method Summary

Modifier and Type	Method and Description
ExportAnalyticsMetricsRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExportAnalyticsMetricsRequest	build()
ExportAnalyticsMetricsRequest	buildPartial()
ExportAnalyticsMetricsRequest.Builder	clear()
ExportAnalyticsMetricsRequest.Builder	clearCatalog() Required.
ExportAnalyticsMetricsRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ExportAnalyticsMetricsRequest.Builder	clearFilter() A filtering expression to specify restrictions on returned metrics.
ExportAnalyticsMetricsRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ExportAnalyticsMetricsRequest.Builder	clearOutputConfig() Required.
ExportAnalyticsMetricsRequest.Builder	clone()
String	getCatalog() Required.
com.google.protobuf.ByteString	getCatalogBytes() Required.
ExportAnalyticsMetricsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() A filtering expression to specify restrictions on returned metrics.
com.google.protobuf.ByteString	getFilterBytes() A filtering expression to specify restrictions on returned metrics.
OutputConfig	getOutputConfig() Required.
OutputConfig.Builder	getOutputConfigBuilder() Required.
OutputConfigOrBuilder	getOutputConfigOrBuilder() Required.
boolean	hasOutputConfig() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ExportAnalyticsMetricsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ExportAnalyticsMetricsRequest.Builder	mergeFrom(ExportAnalyticsMetricsRequest other)
ExportAnalyticsMetricsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ExportAnalyticsMetricsRequest.Builder	mergeOutputConfig(OutputConfig value) Required.
ExportAnalyticsMetricsRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ExportAnalyticsMetricsRequest.Builder	setCatalog(String value) Required.
ExportAnalyticsMetricsRequest.Builder	setCatalogBytes(com.google.protobuf.ByteString value) Required.
ExportAnalyticsMetricsRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExportAnalyticsMetricsRequest.Builder	setFilter(String value) A filtering expression to specify restrictions on returned metrics.
ExportAnalyticsMetricsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) A filtering expression to specify restrictions on returned metrics.
ExportAnalyticsMetricsRequest.Builder	setOutputConfig(OutputConfig.Builder builderForValue) Required.
ExportAnalyticsMetricsRequest.Builder	setOutputConfig(OutputConfig value) Required.
ExportAnalyticsMetricsRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ExportAnalyticsMetricsRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

clear

public ExportAnalyticsMetricsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

getDefaultInstanceForType

public ExportAnalyticsMetricsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ExportAnalyticsMetricsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ExportAnalyticsMetricsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ExportAnalyticsMetricsRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

setField

public ExportAnalyticsMetricsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

clearField

public ExportAnalyticsMetricsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

clearOneof

public ExportAnalyticsMetricsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

setRepeatedField

public ExportAnalyticsMetricsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              int index,
                                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

addRepeatedField

public ExportAnalyticsMetricsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

mergeFrom

public ExportAnalyticsMetricsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportAnalyticsMetricsRequest.Builder>

mergeFrom

public ExportAnalyticsMetricsRequest.Builder mergeFrom(ExportAnalyticsMetricsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

mergeFrom

public ExportAnalyticsMetricsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportAnalyticsMetricsRequest.Builder>

Throws:

IOException

getCatalog

public String getCatalog()

 Required. Full resource name of the parent catalog.
 Expected format: `projects/*/locations/*/catalogs/*`
 

string catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getCatalog in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The catalog.

getCatalogBytes

public com.google.protobuf.ByteString getCatalogBytes()

 Required. Full resource name of the parent catalog.
 Expected format: `projects/*/locations/*/catalogs/*`
 

string catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getCatalogBytes in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The bytes for catalog.

setCatalog

public ExportAnalyticsMetricsRequest.Builder setCatalog(String value)

 Required. Full resource name of the parent catalog.
 Expected format: `projects/*/locations/*/catalogs/*`
 

string catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The catalog to set.

Returns:

This builder for chaining.

clearCatalog

public ExportAnalyticsMetricsRequest.Builder clearCatalog()

 Required. Full resource name of the parent catalog.
 Expected format: `projects/*/locations/*/catalogs/*`
 

string catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

This builder for chaining.

setCatalogBytes

public ExportAnalyticsMetricsRequest.Builder setCatalogBytes(com.google.protobuf.ByteString value)

 Required. Full resource name of the parent catalog.
 Expected format: `projects/*/locations/*/catalogs/*`
 

string catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The bytes for catalog to set.

Returns:

This builder for chaining.

hasOutputConfig

public boolean hasOutputConfig()

 Required. The output location of the data.
 

.google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasOutputConfig in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

Whether the outputConfig field is set.

getOutputConfig

public OutputConfig getOutputConfig()

 Required. The output location of the data.
 

.google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getOutputConfig in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The outputConfig.

setOutputConfig

public ExportAnalyticsMetricsRequest.Builder setOutputConfig(OutputConfig value)

 Required. The output location of the data.
 

.google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

setOutputConfig

public ExportAnalyticsMetricsRequest.Builder setOutputConfig(OutputConfig.Builder builderForValue)

 Required. The output location of the data.
 

.google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

mergeOutputConfig

public ExportAnalyticsMetricsRequest.Builder mergeOutputConfig(OutputConfig value)

 Required. The output location of the data.
 

.google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

clearOutputConfig

public ExportAnalyticsMetricsRequest.Builder clearOutputConfig()

 Required. The output location of the data.
 

.google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

getOutputConfigBuilder

public OutputConfig.Builder getOutputConfigBuilder()

 Required. The output location of the data.
 

.google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

getOutputConfigOrBuilder

public OutputConfigOrBuilder getOutputConfigOrBuilder()

 Required. The output location of the data.
 

.google.cloud.retail.v2.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getOutputConfigOrBuilder in interface ExportAnalyticsMetricsRequestOrBuilder

getFilter

public String getFilter()

 A filtering expression to specify restrictions on returned metrics.
 The expression is a sequence of terms. Each term applies a restriction to
 the returned metrics. Use this expression to restrict results to a
 specific time range.

   Currently we expect only one types of fields:

    * `timestamp`: This can be specified twice, once with a
      less than operator and once with a greater than operator. The
      `timestamp` restriction should result in one, contiguous, valid,
      `timestamp` range.

   Some examples of valid filters expressions:

   * Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
             timestamp < "2012-04-23T18:30:43.511Z"`
   * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
 

string filter = 3;

Specified by:

getFilter in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 A filtering expression to specify restrictions on returned metrics.
 The expression is a sequence of terms. Each term applies a restriction to
 the returned metrics. Use this expression to restrict results to a
 specific time range.

   Currently we expect only one types of fields:

    * `timestamp`: This can be specified twice, once with a
      less than operator and once with a greater than operator. The
      `timestamp` restriction should result in one, contiguous, valid,
      `timestamp` range.

   Some examples of valid filters expressions:

   * Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
             timestamp < "2012-04-23T18:30:43.511Z"`
   * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
 

string filter = 3;

Specified by:

getFilterBytes in interface ExportAnalyticsMetricsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ExportAnalyticsMetricsRequest.Builder setFilter(String value)

 A filtering expression to specify restrictions on returned metrics.
 The expression is a sequence of terms. Each term applies a restriction to
 the returned metrics. Use this expression to restrict results to a
 specific time range.

   Currently we expect only one types of fields:

    * `timestamp`: This can be specified twice, once with a
      less than operator and once with a greater than operator. The
      `timestamp` restriction should result in one, contiguous, valid,
      `timestamp` range.

   Some examples of valid filters expressions:

   * Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
             timestamp < "2012-04-23T18:30:43.511Z"`
   * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
 

string filter = 3;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public ExportAnalyticsMetricsRequest.Builder clearFilter()

 A filtering expression to specify restrictions on returned metrics.
 The expression is a sequence of terms. Each term applies a restriction to
 the returned metrics. Use this expression to restrict results to a
 specific time range.

   Currently we expect only one types of fields:

    * `timestamp`: This can be specified twice, once with a
      less than operator and once with a greater than operator. The
      `timestamp` restriction should result in one, contiguous, valid,
      `timestamp` range.

   Some examples of valid filters expressions:

   * Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
             timestamp < "2012-04-23T18:30:43.511Z"`
   * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
 

string filter = 3;

Returns:

This builder for chaining.

setFilterBytes

public ExportAnalyticsMetricsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

 A filtering expression to specify restrictions on returned metrics.
 The expression is a sequence of terms. Each term applies a restriction to
 the returned metrics. Use this expression to restrict results to a
 specific time range.

   Currently we expect only one types of fields:

    * `timestamp`: This can be specified twice, once with a
      less than operator and once with a greater than operator. The
      `timestamp` restriction should result in one, contiguous, valid,
      `timestamp` range.

   Some examples of valid filters expressions:

   * Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
             timestamp < "2012-04-23T18:30:43.511Z"`
   * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
 

string filter = 3;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

setUnknownFields

public final ExportAnalyticsMetricsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>

mergeUnknownFields

public final ExportAnalyticsMetricsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportAnalyticsMetricsRequest.Builder>