Class FetchReportResultsRequest (3.23.0)

public final class FetchReportResultsRequest extends GeneratedMessageV3 implements FetchReportResultsRequestOrBuilder

Request message for CloudChannelReportsService.FetchReportResults.

Protobuf type google.cloud.channel.v1.FetchReportResultsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITION_KEYS_FIELD_NUMBER

public static final int PARTITION_KEYS_FIELD_NUMBER
Field Value
TypeDescription
int

REPORT_JOB_FIELD_NUMBER

public static final int REPORT_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FetchReportResultsRequest getDefaultInstance()
Returns
TypeDescription
FetchReportResultsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FetchReportResultsRequest.Builder newBuilder()
Returns
TypeDescription
FetchReportResultsRequest.Builder

newBuilder(FetchReportResultsRequest prototype)

public static FetchReportResultsRequest.Builder newBuilder(FetchReportResultsRequest prototype)
Parameter
NameDescription
prototypeFetchReportResultsRequest
Returns
TypeDescription
FetchReportResultsRequest.Builder

parseDelimitedFrom(InputStream input)

public static FetchReportResultsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FetchReportResultsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FetchReportResultsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FetchReportResultsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FetchReportResultsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FetchReportResultsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FetchReportResultsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FetchReportResultsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FetchReportResultsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FetchReportResultsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FetchReportResultsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FetchReportResultsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FetchReportResultsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FetchReportResultsRequest> parser()
Returns
TypeDescription
Parser<FetchReportResultsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public FetchReportResultsRequest getDefaultInstanceForType()
Returns
TypeDescription
FetchReportResultsRequest

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pageToken.

getParserForType()

public Parser<FetchReportResultsRequest> getParserForType()
Returns
TypeDescription
Parser<FetchReportResultsRequest>
Overrides

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for reportJob.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FetchReportResultsRequest.Builder newBuilderForType()
Returns
TypeDescription
FetchReportResultsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FetchReportResultsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FetchReportResultsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FetchReportResultsRequest.Builder toBuilder()
Returns
TypeDescription
FetchReportResultsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException