Class Report.Sort.Builder (0.11.0) 

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

Represents a sorting in a report.

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

Inheritance

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Report.Sort.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Report.Sort.Builder
Overrides

build()

public Report.Sort build()
Returns
Type Description
Report.Sort

buildPartial()

public Report.Sort buildPartial()
Returns
Type Description
Report.Sort

clear()

public Report.Sort.Builder clear()
Returns
Type Description
Report.Sort.Builder
Overrides

clearDescending()

public Report.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
Report.Sort.Builder

This builder for chaining.

clearField()

public Report.Sort.Builder clearField()

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

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

Returns
Type Description
Report.Sort.Builder

clearField(Descriptors.FieldDescriptor field)

public Report.Sort.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Report.Sort.Builder
Overrides

clearMetricValueType()

public Report.Sort.Builder clearMetricValueType()

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

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

Returns
Type Description
Report.Sort.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Report.Sort.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Report.Sort.Builder
Overrides

clearSlice()

public Report.Sort.Builder clearSlice()

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

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

Returns
Type Description
Report.Sort.Builder

clearTimePeriodIndex()

public Report.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
Report.Sort.Builder

This builder for chaining.

clone()

public Report.Sort.Builder clone()
Returns
Type Description
Report.Sort.Builder
Overrides

getDefaultInstanceForType()

public Report.Sort getDefaultInstanceForType()
Returns
Type Description
Report.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

getField()

public Report.Field getField()

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

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

Returns
Type Description
Report.Field

The field.

getFieldBuilder()

public Report.Field.Builder getFieldBuilder()

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

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

Returns
Type Description
Report.Field.Builder

getFieldOrBuilder()

public Report.FieldOrBuilder getFieldOrBuilder()

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

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

Returns
Type Description
Report.FieldOrBuilder

getMetricValueType()

public Report.MetricValueType getMetricValueType()

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

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

Returns
Type Description
Report.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.Report.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 Report.Slice getSlice()

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

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

Returns
Type Description
Report.Slice

The slice.

getSliceBuilder()

public Report.Slice.Builder getSliceBuilder()

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

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

Returns
Type Description
Report.Slice.Builder

getSliceOrBuilder()

public Report.SliceOrBuilder getSliceOrBuilder()

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

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

Returns
Type Description
Report.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.Report.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.Report.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.Report.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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeField(Report.Field value)

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

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

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

Parameter
Name Description
value Report.Field
Returns
Type Description
Report.Sort.Builder

mergeFrom(Report.Sort other)

public Report.Sort.Builder mergeFrom(Report.Sort other)
Parameter
Name Description
other Report.Sort
Returns
Type Description
Report.Sort.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Report.Sort.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Report.Sort.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Report.Sort.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Report.Sort.Builder
Overrides

mergeSlice(Report.Slice value)

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

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

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

Parameter
Name Description
value Report.Slice
Returns
Type Description
Report.Sort.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Report.Sort.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Report.Sort.Builder
Overrides

setDescending(boolean value)

public Report.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
Report.Sort.Builder

This builder for chaining.

setField(Report.Field value)

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

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

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

Parameter
Name Description
value Report.Field
Returns
Type Description
Report.Sort.Builder

setField(Report.Field.Builder builderForValue)

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

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

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

Parameter
Name Description
builderForValue Report.Field.Builder
Returns
Type Description
Report.Sort.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Report.Sort.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Report.Sort.Builder
Overrides

setMetricValueType(Report.MetricValueType value)

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

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

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

Parameter
Name Description
value Report.MetricValueType

The metricValueType to set.
Returns
Type Description
Report.Sort.Builder

This builder for chaining.

setMetricValueTypeValue(int value)

public Report.Sort.Builder setMetricValueTypeValue(int value)

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

optional .google.ads.admanager.v1.Report.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
Report.Sort.Builder

This builder for chaining.

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

public Report.Sort.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Report.Sort.Builder
Overrides

setSlice(Report.Slice value)

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

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

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

Parameter
Name Description
value Report.Slice
Returns
Type Description
Report.Sort.Builder

setSlice(Report.Slice.Builder builderForValue)

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

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

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

Parameter
Name Description
builderForValue Report.Slice.Builder
Returns
Type Description
Report.Sort.Builder

setTimePeriodIndex(int value)

public Report.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
Report.Sort.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Report.Sort.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Report.Sort.Builder
Overrides