Class Report.Sort.Builder (0.31.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

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