Class RunReportJobRequest.Builder (3.46.0)

public static final class RunReportJobRequest.Builder extends GeneratedMessageV3.Builder<RunReportJobRequest.Builder> implements RunReportJobRequestOrBuilder

Request message for CloudChannelReportsService.RunReportJob.

Protobuf type google.cloud.channel.v1.RunReportJobRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RunReportJobRequest build()
Returns
Type Description
RunReportJobRequest

buildPartial()

public RunReportJobRequest buildPartial()
Returns
Type Description
RunReportJobRequest

clear()

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

clearDateRange()

public RunReportJobRequest.Builder clearDateRange()

Optional. The range of usage or invoice dates to include in the result.

.google.cloud.channel.v1.DateRange date_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RunReportJobRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public RunReportJobRequest.Builder clearFilter()

Optional. A structured string that defines conditions on dimension columns to restrict the report output.

Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys.

For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

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

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

clearLanguageCode()

public RunReportJobRequest.Builder clearLanguageCode()

Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

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

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

clearName()

public RunReportJobRequest.Builder clearName()

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}

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

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDateRange()

public DateRange getDateRange()

Optional. The range of usage or invoice dates to include in the result.

.google.cloud.channel.v1.DateRange date_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DateRange

The dateRange.

getDateRangeBuilder()

public DateRange.Builder getDateRangeBuilder()

Optional. The range of usage or invoice dates to include in the result.

.google.cloud.channel.v1.DateRange date_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DateRange.Builder

getDateRangeOrBuilder()

public DateRangeOrBuilder getDateRangeOrBuilder()

Optional. The range of usage or invoice dates to include in the result.

.google.cloud.channel.v1.DateRange date_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DateRangeOrBuilder

getDefaultInstanceForType()

public RunReportJobRequest getDefaultInstanceForType()
Returns
Type Description
RunReportJobRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. A structured string that defines conditions on dimension columns to restrict the report output.

Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys.

For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A structured string that defines conditions on dimension columns to restrict the report output.

Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys.

For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

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

Returns
Type Description
ByteString

The bytes for filter.

getLanguageCode()

public String getLanguageCode()

Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

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

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

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

Returns
Type Description
ByteString

The bytes for languageCode.

getName()

public String getName()

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}

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

Returns
Type Description
ByteString

The bytes for name.

hasDateRange()

public boolean hasDateRange()

Optional. The range of usage or invoice dates to include in the result.

.google.cloud.channel.v1.DateRange date_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dateRange field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDateRange(DateRange value)

public RunReportJobRequest.Builder mergeDateRange(DateRange value)

Optional. The range of usage or invoice dates to include in the result.

.google.cloud.channel.v1.DateRange date_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DateRange
Returns
Type Description
RunReportJobRequest.Builder

mergeFrom(RunReportJobRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDateRange(DateRange value)

public RunReportJobRequest.Builder setDateRange(DateRange value)

Optional. The range of usage or invoice dates to include in the result.

.google.cloud.channel.v1.DateRange date_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DateRange
Returns
Type Description
RunReportJobRequest.Builder

setDateRange(DateRange.Builder builderForValue)

public RunReportJobRequest.Builder setDateRange(DateRange.Builder builderForValue)

Optional. The range of usage or invoice dates to include in the result.

.google.cloud.channel.v1.DateRange date_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DateRange.Builder
Returns
Type Description
RunReportJobRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public RunReportJobRequest.Builder setFilter(String value)

Optional. A structured string that defines conditions on dimension columns to restrict the report output.

Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys.

For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public RunReportJobRequest.Builder setFilterBytes(ByteString value)

Optional. A structured string that defines conditions on dimension columns to restrict the report output.

Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys.

For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

setLanguageCode(String value)

public RunReportJobRequest.Builder setLanguageCode(String value)

Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

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

Parameter
Name Description
value String

The languageCode to set.

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public RunReportJobRequest.Builder setLanguageCodeBytes(ByteString value)

Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

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

Parameter
Name Description
value ByteString

The bytes for languageCode to set.

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

setName(String value)

public RunReportJobRequest.Builder setName(String value)

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RunReportJobRequest.Builder setNameBytes(ByteString value)

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RunReportJobRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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