Package com.google.cloud.recommender.v1beta1

Class ListRecommendationsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<ListRecommendationsRequest.Builder>

com.google.cloud.recommender.v1beta1.ListRecommendationsRequest.Builder

All Implemented Interfaces:

ListRecommendationsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListRecommendationsRequest

public static final class ListRecommendationsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListRecommendationsRequest.Builder>
implements ListRecommendationsRequestOrBuilder

 Request for the `ListRecommendations` method.
 

Protobuf type google.cloud.recommender.v1beta1.ListRecommendationsRequest

Method Summary

Modifier and Type	Method	Description
ListRecommendationsRequest	build()
ListRecommendationsRequest	buildPartial()
ListRecommendationsRequest.Builder	clear()
ListRecommendationsRequest.Builder	clearFilter()	Filter expression to restrict the recommendations returned.
ListRecommendationsRequest.Builder	clearPageSize()	Optional.
ListRecommendationsRequest.Builder	clearPageToken()	Optional.
ListRecommendationsRequest.Builder	clearParent()	Required.
ListRecommendationsRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter()	Filter expression to restrict the recommendations returned.
com.google.protobuf.ByteString	getFilterBytes()	Filter expression to restrict the recommendations returned.
int	getPageSize()	Optional.
String	getPageToken()	Optional.
com.google.protobuf.ByteString	getPageTokenBytes()	Optional.
String	getParent()	Required.
com.google.protobuf.ByteString	getParentBytes()	Required.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
ListRecommendationsRequest.Builder	mergeFrom(ListRecommendationsRequest other)
ListRecommendationsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListRecommendationsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListRecommendationsRequest.Builder	setFilter(String value)	Filter expression to restrict the recommendations returned.
ListRecommendationsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value)	Filter expression to restrict the recommendations returned.
ListRecommendationsRequest.Builder	setPageSize(int value)	Optional.
ListRecommendationsRequest.Builder	setPageToken(String value)	Optional.
ListRecommendationsRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value)	Optional.
ListRecommendationsRequest.Builder	setParent(String value)	Required.
ListRecommendationsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value)	Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListRecommendationsRequest.Builder>

clear

public ListRecommendationsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<ListRecommendationsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListRecommendationsRequest.Builder>

getDefaultInstanceForType

public ListRecommendationsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListRecommendationsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListRecommendationsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public ListRecommendationsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListRecommendationsRequest.Builder>

mergeFrom

public ListRecommendationsRequest.Builder mergeFrom(ListRecommendationsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListRecommendationsRequest.Builder>

mergeFrom

public ListRecommendationsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListRecommendationsRequest.Builder>

Throws:

IOException

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) = { ... }

Specified by:

getParent in interface ListRecommendationsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.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) = { ... }

Specified by:

getParentBytes in interface ListRecommendationsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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) = { ... }

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

public ListRecommendationsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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];

Specified by:

getPageSize in interface ListRecommendationsRequestOrBuilder

Returns:

The pageSize.

setPageSize

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];

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

getPageToken

public String getPageToken()

 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];

Specified by:

getPageToken in interface ListRecommendationsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 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];

Specified by:

getPageTokenBytes in interface ListRecommendationsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListRecommendationsRequest.Builder setPageToken(String value)

 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];

Parameters:

value - The pageToken to set.

Returns:

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:

This builder for chaining.

setPageTokenBytes

public ListRecommendationsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 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];

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

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;

Specified by:

getFilter in interface ListRecommendationsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.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;

Specified by:

getFilterBytes in interface ListRecommendationsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

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;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setFilterBytes

public ListRecommendationsRequest.Builder setFilterBytes(com.google.protobuf.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;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.