- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.7
- 2.4.1
- 2.3.0
- 2.2.0
- 2.1.5
public static final class ListRecommendationsRequest.Builder extends GeneratedMessageV3.Builder<ListRecommendationsRequest.Builder> implements ListRecommendationsRequestOrBuilder Request for the ListRecommendations method.
Protobuf type google.cloud.recommender.v1.ListRecommendationsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListRecommendationsRequest.BuilderImplements
ListRecommendationsRequestOrBuilderStatic 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 |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public ListRecommendationsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListRecommendationsRequest.Builder |
|
clearFilter()
public ListRecommendationsRequest.Builder clearFilter()Filter expression to restrict the recommendations returned. Supported filter fields:
state_info.staterecommenderSubtypeprioritytargetResourcesExamples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSEDrecommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLEpriority = P1 OR priority = P2targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)The max allowed filter length is 500 characters.
(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 |
|
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 |
|
getDefaultInstanceForType()
public ListRecommendationsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListRecommendationsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter()Filter expression to restrict the recommendations returned. Supported filter fields:
state_info.staterecommenderSubtypeprioritytargetResourcesExamples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSEDrecommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLEpriority = P1 OR priority = P2targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)The max allowed filter length is 500 characters.
(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.staterecommenderSubtypeprioritytargetResourcesExamples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSEDrecommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLEpriority = P1 OR priority = P2targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)The max allowed filter length is 500 characters.
(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() 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 |
String |
The pageToken. |
getPageTokenBytes()
public 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];
| 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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListRecommendationsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListRecommendationsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListRecommendationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListRecommendationsRequest.Builder |
|
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 |
|
setFilter(String value)
public ListRecommendationsRequest.Builder setFilter(String value)Filter expression to restrict the recommendations returned. Supported filter fields:
state_info.staterecommenderSubtypeprioritytargetResourcesExamples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSEDrecommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLEpriority = P1 OR priority = P2targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)The max allowed filter length is 500 characters.
(These expressions are based on the filter language described at https://google.aip.dev/160)
string filter = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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.staterecommenderSubtypeprioritytargetResourcesExamples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSEDrecommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLEpriority = P1 OR priority = P2targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)The max allowed filter length is 500 characters.
(These expressions are based on the filter language described at https://google.aip.dev/160)
string filter = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListRecommendationsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListRecommendationsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListRecommendationsRequest.Builder setPageTokenBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListRecommendationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListRecommendationsRequest.Builder |
|