Class RunReportJobRequest.Builder (3.33.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunReportJobRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunReportJobRequest.Builder
Overrides

build()

public RunReportJobRequest build()
Returns
TypeDescription
RunReportJobRequest

buildPartial()

public RunReportJobRequest buildPartial()
Returns
TypeDescription
RunReportJobRequest

clear()

public RunReportJobRequest.Builder clear()
Returns
TypeDescription
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
TypeDescription
RunReportJobRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RunReportJobRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
RunReportJobRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RunReportJobRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RunReportJobRequest.Builder
Overrides

clone()

public RunReportJobRequest.Builder clone()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
DateRangeOrBuilder

getDefaultInstanceForType()

public RunReportJobRequest getDefaultInstanceForType()
Returns
TypeDescription
RunReportJobRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the dateRange field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueDateRange
Returns
TypeDescription
RunReportJobRequest.Builder

mergeFrom(RunReportJobRequest other)

public RunReportJobRequest.Builder mergeFrom(RunReportJobRequest other)
Parameter
NameDescription
otherRunReportJobRequest
Returns
TypeDescription
RunReportJobRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunReportJobRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunReportJobRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RunReportJobRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RunReportJobRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunReportJobRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueDateRange
Returns
TypeDescription
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
NameDescription
builderForValueDateRange.Builder
Returns
TypeDescription
RunReportJobRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunReportJobRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The filter to set.

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

The bytes for filter to set.

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

The languageCode to set.

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

The bytes for languageCode to set.

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

The name to set.

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

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RunReportJobRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RunReportJobRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunReportJobRequest.Builder
Overrides