Class ListOffersRequest.Builder (3.52.0)

public static final class ListOffersRequest.Builder extends GeneratedMessageV3.Builder<ListOffersRequest.Builder> implements ListOffersRequestOrBuilder

Request message for ListOffers.

Protobuf type google.cloud.channel.v1.ListOffersRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListOffersRequest build()
Returns
Type Description
ListOffersRequest

buildPartial()

public ListOffersRequest buildPartial()
Returns
Type Description
ListOffersRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListOffersRequest.Builder clearFilter()

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

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

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

clearLanguageCode()

public ListOffersRequest.Builder clearLanguageCode()

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".

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

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListOffersRequest.Builder clearPageSize()

Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.

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

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

clearPageToken()

public ListOffersRequest.Builder clearPageToken()

Optional. A token for a page of results other than the first page.

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

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

clearParent()

public ListOffersRequest.Builder clearParent()

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

clearShowFutureOffers()

public ListOffersRequest.Builder clearShowFutureOffers()

Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.

bool show_future_offers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListOffersRequest getDefaultInstanceForType()
Returns
Type Description
ListOffersRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

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

Returns
Type Description
ByteString

The bytes for filter.

getLanguageCode()

public String getLanguageCode()

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".

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

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".

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

Returns
Type Description
ByteString

The bytes for languageCode.

getPageSize()

public int getPageSize()

Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A token for a page of results other than the first page.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A token for a page of results other than the first page.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getShowFutureOffers()

public boolean getShowFutureOffers()

Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.

bool show_future_offers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The showFutureOffers.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListOffersRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListOffersRequest.Builder setFilter(String value)

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListOffersRequest.Builder setFilterBytes(ByteString value)

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setLanguageCode(String value)

public ListOffersRequest.Builder setLanguageCode(String value)

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".

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

Parameter
Name Description
value String

The languageCode to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public ListOffersRequest.Builder setLanguageCodeBytes(ByteString value)

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".

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

Parameter
Name Description
value ByteString

The bytes for languageCode to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListOffersRequest.Builder setPageSize(int value)

Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListOffersRequest.Builder setPageToken(String value)

Optional. A token for a page of results other than the first page.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListOffersRequest.Builder setPageTokenBytes(ByteString value)

Optional. A token for a page of results other than the first page.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setParent(String value)

public ListOffersRequest.Builder setParent(String value)

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListOffersRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

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

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

setShowFutureOffers(boolean value)

public ListOffersRequest.Builder setShowFutureOffers(boolean value)

Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.

bool show_future_offers = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The showFutureOffers to set.

Returns
Type Description
ListOffersRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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