Class ExportAnalyticsMetricsRequest.Builder (2.44.0)

Version 2.44.0

• 2.45.0 (latest)
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

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

Request message for the ExportAnalyticsMetrics method.

Protobuf type google.cloud.retail.v2beta.ExportAnalyticsMetricsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportAnalyticsMetricsRequest.Builder

Implements

ExportAnalyticsMetricsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ExportAnalyticsMetricsRequest build()

Returns
Type	Description
ExportAnalyticsMetricsRequest

buildPartial()

public ExportAnalyticsMetricsRequest buildPartial()

Returns
Type	Description
ExportAnalyticsMetricsRequest

clear()

public ExportAnalyticsMetricsRequest.Builder clear()

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
ExportAnalyticsMetricsRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExportAnalyticsMetricsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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:

* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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
Type	Description
ExportAnalyticsMetricsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportAnalyticsMetricsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOutputConfig()

public ExportAnalyticsMetricsRequest.Builder clearOutputConfig()

Required. The output location of the data.

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

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

clone()

public ExportAnalyticsMetricsRequest.Builder clone()

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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];

Returns
Type	Description
String	The catalog.

getCatalogBytes()

public ByteString getCatalogBytes()

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

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

Returns
Type	Description
ByteString	The bytes for catalog.

getDefaultInstanceForType()

public ExportAnalyticsMetricsRequest getDefaultInstanceForType()

Returns
Type	Description
ExportAnalyticsMetricsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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:

* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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
Type	Description
String	The filter.

getFilterBytes()

public 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:

* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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
Type	Description
ByteString	The bytes for filter.

getOutputConfig()

public OutputConfig getOutputConfig()

Required. The output location of the data.

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

Returns
Type	Description
OutputConfig	The outputConfig.

getOutputConfigBuilder()

public OutputConfig.Builder getOutputConfigBuilder()

Required. The output location of the data.

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

Returns
Type	Description
OutputConfig.Builder

getOutputConfigOrBuilder()

public OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. The output location of the data.

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

Returns
Type	Description
OutputConfigOrBuilder

hasOutputConfig()

public boolean hasOutputConfig()

Required. The output location of the data.

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

Returns
Type	Description
boolean	Whether the outputConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ExportAnalyticsMetricsRequest other)

public ExportAnalyticsMetricsRequest.Builder mergeFrom(ExportAnalyticsMetricsRequest other)

Parameter
Name	Description
other	ExportAnalyticsMetricsRequest

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportAnalyticsMetricsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ExportAnalyticsMetricsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeOutputConfig(OutputConfig value)

public ExportAnalyticsMetricsRequest.Builder mergeOutputConfig(OutputConfig value)

Required. The output location of the data.

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

Parameter
Name	Description
value	OutputConfig

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportAnalyticsMetricsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCatalog(String value)

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];

Parameter
Name	Description
value	String The catalog to set.

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder	This builder for chaining.

setCatalogBytes(ByteString value)

public ExportAnalyticsMetricsRequest.Builder setCatalogBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for catalog to set.

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

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:

* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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;

Parameter
Name	Description
value	String The filter to set.

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ExportAnalyticsMetricsRequest.Builder setFilterBytes(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:

* <code>timestamp</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>timestamp</code> restriction should result in one, contiguous, valid,
  <code>timestamp</code> 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;

Parameter
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder	This builder for chaining.

setOutputConfig(OutputConfig value)

public ExportAnalyticsMetricsRequest.Builder setOutputConfig(OutputConfig value)

Required. The output location of the data.

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

Parameter
Name	Description
value	OutputConfig

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

setOutputConfig(OutputConfig.Builder builderForValue)

public ExportAnalyticsMetricsRequest.Builder setOutputConfig(OutputConfig.Builder builderForValue)

Required. The output location of the data.

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

Parameter
Name	Description
builderForValue	OutputConfig.Builder

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportAnalyticsMetricsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ExportAnalyticsMetricsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)