Class FetchReportResultsRequest.Builder (3.46.0) 

public static final class FetchReportResultsRequest.Builder extends GeneratedMessageV3.Builder<FetchReportResultsRequest.Builder> implements FetchReportResultsRequestOrBuilder

Request message for CloudChannelReportsService.FetchReportResults.

Protobuf type google.cloud.channel.v1.FetchReportResultsRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllPartitionKeys(Iterable<String> values)

public FetchReportResultsRequest.Builder addAllPartitionKeys(Iterable<String> values)

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The partitionKeys to add.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

addPartitionKeys(String value)

public FetchReportResultsRequest.Builder addPartitionKeys(String value)

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The partitionKeys to add.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

addPartitionKeysBytes(ByteString value)

public FetchReportResultsRequest.Builder addPartitionKeysBytes(ByteString value)

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the partitionKeys to add.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FetchReportResultsRequest build()
Returns
Type Description
FetchReportResultsRequest

buildPartial()

public FetchReportResultsRequest buildPartial()
Returns
Type Description
FetchReportResultsRequest

clear()

public FetchReportResultsRequest.Builder clear()
Returns
Type Description
FetchReportResultsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public FetchReportResultsRequest.Builder clearPageSize()

Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time).

The maximum value is 30,000; the server will change larger values to 30,000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

clearPageToken()

public FetchReportResultsRequest.Builder clearPageToken()

Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

clearPartitionKeys()

public FetchReportResultsRequest.Builder clearPartitionKeys()

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

clearReportJob()

public FetchReportResultsRequest.Builder clearReportJob()

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

clone()

public FetchReportResultsRequest.Builder clone()
Returns
Type Description
FetchReportResultsRequest.Builder
Overrides

getDefaultInstanceForType()

public FetchReportResultsRequest getDefaultInstanceForType()
Returns
Type Description
FetchReportResultsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int getPageSize()

Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time).

The maximum value is 30,000; the server will change larger values to 30,000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getPartitionKeys(int index)

public String getPartitionKeys(int index)

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The partitionKeys at the given index.

getPartitionKeysBytes(int index)

public ByteString getPartitionKeysBytes(int index)

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the partitionKeys at the given index.

getPartitionKeysCount()

public int getPartitionKeysCount()

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of partitionKeys.

getPartitionKeysList()

public ProtocolStringList getPartitionKeysList()

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the partitionKeys.

getReportJob()

public String getReportJob()

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The reportJob.

getReportJobBytes()

public ByteString getReportJobBytes()

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for reportJob.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FetchReportResultsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public FetchReportResultsRequest.Builder setPageSize(int value)

Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time).

The maximum value is 30,000; the server will change larger values to 30,000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

setPageToken(String value)

public FetchReportResultsRequest.Builder setPageToken(String value)

Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public FetchReportResultsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

setPartitionKeys(int index, String value)

public FetchReportResultsRequest.Builder setPartitionKeys(int index, String value)

Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.

repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value String

The partitionKeys to set.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

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

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

setReportJob(String value)

public FetchReportResultsRequest.Builder setReportJob(String value)

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The reportJob to set.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

setReportJobBytes(ByteString value)

public FetchReportResultsRequest.Builder setReportJobBytes(ByteString value)

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for reportJob to set.
Returns
Type Description
FetchReportResultsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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