Class ListRecommendationsRequest.Builder (2.15.0)

public static final class ListRecommendationsRequest.Builder extends GeneratedMessageV3.Builder<ListRecommendationsRequest.Builder> implements ListRecommendationsRequestOrBuilder

Request for the ListRecommendations method.

Protobuf type google.cloud.recommender.v1beta1.ListRecommendationsRequest

Inheritance

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

Implements

ListRecommendationsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListRecommendationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListRecommendationsRequest build()

Returns
Type	Description
`ListRecommendationsRequest`

buildPartial()

public ListRecommendationsRequest buildPartial()

Returns
Type	Description
`ListRecommendationsRequest`

clear()

public ListRecommendationsRequest.Builder clear()

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListRecommendationsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ListRecommendationsRequest.Builder clearFilter()

Filter expression to restrict the recommendations returned. Supported filter fields:

state_info.state
recommenderSubtype
priority Examples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE
priority = P1 OR priority = P2
stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) (These expressions are based on the filter language described at https://google.aip.dev/160)

string filter = 5;

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListRecommendationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPageSize()

public ListRecommendationsRequest.Builder clearPageSize()

Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

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

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

clearPageToken()

public ListRecommendationsRequest.Builder clearPageToken()

Optional. If present, retrieves the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters must be identical to those in the previous call.

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

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

clearParent()

public ListRecommendationsRequest.Builder clearParent()

Required. The container resource on which to execute the request. Acceptable formats:

projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

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

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

clone()

public ListRecommendationsRequest.Builder clone()

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListRecommendationsRequest getDefaultInstanceForType()

Returns
Type	Description
`ListRecommendationsRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

Filter expression to restrict the recommendations returned. Supported filter fields:

state_info.state
recommenderSubtype
priority Examples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE
priority = P1 OR priority = P2
stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) (These expressions are based on the filter language described at https://google.aip.dev/160)

string filter = 5;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Filter expression to restrict the recommendations returned. Supported filter fields:

state_info.state
recommenderSubtype
priority Examples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE
priority = P1 OR priority = P2
stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) (These expressions are based on the filter language described at https://google.aip.dev/160)

string filter = 5;

Returns
Type	Description
`ByteString`	The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

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

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public String getPageToken()

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

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getParent()

public String getParent()

Required. The container resource on which to execute the request. Acceptable formats:

projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

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

Returns
Type	Description
`String`	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The container resource on which to execute the request. Acceptable formats:

projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

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

Returns
Type	Description
`ByteString`	The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListRecommendationsRequest other)

public ListRecommendationsRequest.Builder mergeFrom(ListRecommendationsRequest other)

Parameter
Name	Description
`other`	`ListRecommendationsRequest`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListRecommendationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ListRecommendationsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListRecommendationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListRecommendationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public ListRecommendationsRequest.Builder setFilter(String value)

Filter expression to restrict the recommendations returned. Supported filter fields:

state_info.state
recommenderSubtype
priority Examples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE
priority = P1 OR priority = P2
stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) (These expressions are based on the filter language described at https://google.aip.dev/160)

string filter = 5;

Parameter
Name	Description
`value`	`String` The filter to set.

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

setFilterBytes(ByteString value)

public ListRecommendationsRequest.Builder setFilterBytes(ByteString value)

Filter expression to restrict the recommendations returned. Supported filter fields:

state_info.state
recommenderSubtype
priority Examples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE
priority = P1 OR priority = P2
stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) (These expressions are based on the filter language described at https://google.aip.dev/160)

string filter = 5;

Parameter
Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

setPageSize(int value)

public ListRecommendationsRequest.Builder setPageSize(int value)

Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

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

Parameter
Name	Description
`value`	`int` The pageSize to set.

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

setPageToken(String value)

public ListRecommendationsRequest.Builder setPageToken(String value)

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

Parameter
Name	Description
`value`	`String` The pageToken to set.

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListRecommendationsRequest.Builder setPageTokenBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for pageToken to set.

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

setParent(String value)

public ListRecommendationsRequest.Builder setParent(String value)

Required. The container resource on which to execute the request. Acceptable formats:

projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

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

Parameter
Name	Description
`value`	`String` The parent to set.

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

setParentBytes(ByteString value)

public ListRecommendationsRequest.Builder setParentBytes(ByteString value)

Required. The container resource on which to execute the request. Acceptable formats:

projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

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

Parameter
Name	Description
`value`	`ByteString` The bytes for parent to set.

Returns
Type	Description
`ListRecommendationsRequest.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListRecommendationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ListRecommendationsRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)