Class ReportDefinition.Sort.Builder (0.39.0)

Version latest

• 0.39.0 (latest)
• 0.37.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.29.0
• 0.27.0
• 0.26.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class ReportDefinition.Sort.Builder extends GeneratedMessageV3.Builder<ReportDefinition.Sort.Builder> implements ReportDefinition.SortOrBuilder

Represents a sorting in a report.

Protobuf type google.ads.admanager.v1.ReportDefinition.Sort

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReportDefinition.Sort.Builder

Implements

ReportDefinition.SortOrBuilder

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 ReportDefinition.Sort.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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

build()

public ReportDefinition.Sort build()

Returns
Type	Description
ReportDefinition.Sort

buildPartial()

public ReportDefinition.Sort buildPartial()

Returns
Type	Description
ReportDefinition.Sort

clear()

public ReportDefinition.Sort.Builder clear()

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDescending()

public ReportDefinition.Sort.Builder clearDescending()

Optional. The sort order. If true the sort will be descending.

bool descending = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.Sort.Builder	This builder for chaining.

clearField()

public ReportDefinition.Sort.Builder clearField()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ReportDefinition.Sort.Builder

clearField(Descriptors.FieldDescriptor field)

public ReportDefinition.Sort.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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

clearMetricValueType()

public ReportDefinition.Sort.Builder clearMetricValueType()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.Sort.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReportDefinition.Sort.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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

clearSlice()

public ReportDefinition.Sort.Builder clearSlice()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.Sort.Builder

clearTimePeriodIndex()

public ReportDefinition.Sort.Builder clearTimePeriodIndex()

Optional. When using time period columns, use this to sort on a specific column.

optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.Sort.Builder	This builder for chaining.

clone()

public ReportDefinition.Sort.Builder clone()

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ReportDefinition.Sort getDefaultInstanceForType()

Returns
Type	Description
ReportDefinition.Sort

getDescending()

public boolean getDescending()

Optional. The sort order. If true the sort will be descending.

bool descending = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The descending.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getField()

public ReportDefinition.Field getField()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ReportDefinition.Field	The field.

getFieldBuilder()

public ReportDefinition.Field.Builder getFieldBuilder()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ReportDefinition.Field.Builder

getFieldOrBuilder()

public ReportDefinition.FieldOrBuilder getFieldOrBuilder()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ReportDefinition.FieldOrBuilder

getMetricValueType()

public ReportDefinition.MetricValueType getMetricValueType()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.MetricValueType	The metricValueType.

getMetricValueTypeValue()

public int getMetricValueTypeValue()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for metricValueType.

getSlice()

public ReportDefinition.Slice getSlice()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.Slice	The slice.

getSliceBuilder()

public ReportDefinition.Slice.Builder getSliceBuilder()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.Slice.Builder

getSliceOrBuilder()

public ReportDefinition.SliceOrBuilder getSliceOrBuilder()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.SliceOrBuilder

getTimePeriodIndex()

public int getTimePeriodIndex()

Optional. When using time period columns, use this to sort on a specific column.

optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The timePeriodIndex.

hasField()

public boolean hasField()

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the field field is set.

hasMetricValueType()

public boolean hasMetricValueType()

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the metricValueType field is set.

hasSlice()

public boolean hasSlice()

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the slice field is set.

hasTimePeriodIndex()

public boolean hasTimePeriodIndex()

Optional. When using time period columns, use this to sort on a specific column.

optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the timePeriodIndex 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()

mergeField(ReportDefinition.Field value)

public ReportDefinition.Sort.Builder mergeField(ReportDefinition.Field value)

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ReportDefinition.Field

Returns
Type	Description
ReportDefinition.Sort.Builder

mergeFrom(ReportDefinition.Sort other)

public ReportDefinition.Sort.Builder mergeFrom(ReportDefinition.Sort other)

Parameter
Name	Description
other	ReportDefinition.Sort

Returns
Type	Description
ReportDefinition.Sort.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReportDefinition.Sort.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ReportDefinition.Sort.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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

mergeSlice(ReportDefinition.Slice value)

public ReportDefinition.Sort.Builder mergeSlice(ReportDefinition.Slice value)

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ReportDefinition.Slice

Returns
Type	Description
ReportDefinition.Sort.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReportDefinition.Sort.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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

setDescending(boolean value)

public ReportDefinition.Sort.Builder setDescending(boolean value)

Optional. The sort order. If true the sort will be descending.

bool descending = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The descending to set.

Returns
Type	Description
ReportDefinition.Sort.Builder	This builder for chaining.

setField(ReportDefinition.Field value)

public ReportDefinition.Sort.Builder setField(ReportDefinition.Field value)

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ReportDefinition.Field

Returns
Type	Description
ReportDefinition.Sort.Builder

setField(ReportDefinition.Field.Builder builderForValue)

public ReportDefinition.Sort.Builder setField(ReportDefinition.Field.Builder builderForValue)

Required. A field (dimension or metric) to sort by.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	ReportDefinition.Field.Builder

Returns
Type	Description
ReportDefinition.Sort.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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

setMetricValueType(ReportDefinition.MetricValueType value)

public ReportDefinition.Sort.Builder setMetricValueType(ReportDefinition.MetricValueType value)

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ReportDefinition.MetricValueType The metricValueType to set.

Returns
Type	Description
ReportDefinition.Sort.Builder	This builder for chaining.

setMetricValueTypeValue(int value)

public ReportDefinition.Sort.Builder setMetricValueTypeValue(int value)

Optional. Use to specify which metric value type to sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for metricValueType to set.

Returns
Type	Description
ReportDefinition.Sort.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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

setSlice(ReportDefinition.Slice value)

public ReportDefinition.Sort.Builder setSlice(ReportDefinition.Slice value)

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ReportDefinition.Slice

Returns
Type	Description
ReportDefinition.Sort.Builder

setSlice(ReportDefinition.Slice.Builder builderForValue)

public ReportDefinition.Sort.Builder setSlice(ReportDefinition.Slice.Builder builderForValue)

Optional. Use to sort on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	ReportDefinition.Slice.Builder

Returns
Type	Description
ReportDefinition.Sort.Builder

setTimePeriodIndex(int value)

public ReportDefinition.Sort.Builder setTimePeriodIndex(int value)

Optional. When using time period columns, use this to sort on a specific column.

optional int32 time_period_index = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The timePeriodIndex to set.

Returns
Type	Description
ReportDefinition.Sort.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReportDefinition.Sort.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ReportDefinition.Sort.Builder

Overrides

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