Class SearchAllResourcesRequest.Builder (3.24.0)

public static final class SearchAllResourcesRequest.Builder extends GeneratedMessageV3.Builder<SearchAllResourcesRequest.Builder> implements SearchAllResourcesRequestOrBuilder

Search all resources request.

Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesRequest

Static Methods

getDescriptor()

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

Methods

addAllAssetTypes(Iterable<String> values)

public SearchAllResourcesRequest.Builder addAllAssetTypes(Iterable<String> values)

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Parameter
Name Description
values Iterable<String>

The assetTypes to add.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

addAssetTypes(String value)

public SearchAllResourcesRequest.Builder addAssetTypes(String value)

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Parameter
Name Description
value String

The assetTypes to add.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

addAssetTypesBytes(ByteString value)

public SearchAllResourcesRequest.Builder addAssetTypesBytes(ByteString value)

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Parameter
Name Description
value ByteString

The bytes of the assetTypes to add.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SearchAllResourcesRequest build()
Returns
Type Description
SearchAllResourcesRequest

buildPartial()

public SearchAllResourcesRequest buildPartial()
Returns
Type Description
SearchAllResourcesRequest

clear()

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

clearAssetTypes()

public SearchAllResourcesRequest.Builder clearAssetTypes()

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public SearchAllResourcesRequest.Builder clearOrderBy()

Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add DESC after the field name to indicate descending order. Redundant space characters are ignored. For example, location DESC , name .

string order_by = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

clearPageSize()

public SearchAllResourcesRequest.Builder clearPageSize()

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

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

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

clearPageToken()

public SearchAllResourcesRequest.Builder clearPageToken()

Optional. If present, then retrieve 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 all other method parameters, must be identical to those in the previous call.

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

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

clearQuery()

public SearchAllResourcesRequest.Builder clearQuery()

Optional. The query statement.

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

clearScope()

public SearchAllResourcesRequest.Builder clearScope()

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

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

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

clone()

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

getAssetTypes(int index)

public String getAssetTypes(int index)

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The assetTypes at the given index.

getAssetTypesBytes(int index)

public ByteString getAssetTypesBytes(int index)

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the assetTypes at the given index.

getAssetTypesCount()

public int getAssetTypesCount()

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Returns
Type Description
int

The count of assetTypes.

getAssetTypesList()

public ProtocolStringList getAssetTypesList()

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Returns
Type Description
ProtocolStringList

A list containing the assetTypes.

getDefaultInstanceForType()

public SearchAllResourcesRequest getDefaultInstanceForType()
Returns
Type Description
SearchAllResourcesRequest

getDescriptorForType()

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

getOrderBy()

public String getOrderBy()

Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add DESC after the field name to indicate descending order. Redundant space characters are ignored. For example, location DESC , name .

string order_by = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add DESC after the field name to indicate descending order. Redundant space characters are ignored. For example, location DESC , name .

string order_by = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. If present, then retrieve 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 all other method parameters, must be identical to those in the previous call.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. If present, then retrieve 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 all other method parameters, must be identical to those in the previous call.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getQuery()

public String getQuery()

Optional. The query statement.

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Optional. The query statement.

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for query.

getScope()

public String getScope()

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

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

Returns
Type Description
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

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

Returns
Type Description
ByteString

The bytes for scope.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchAllResourcesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAssetTypes(int index, String value)

public SearchAllResourcesRequest.Builder setAssetTypes(int index, String value)

Optional. A list of asset types that this request searches for. If empty, it will search all the supported asset types.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The assetTypes to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setOrderBy(String value)

public SearchAllResourcesRequest.Builder setOrderBy(String value)

Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add DESC after the field name to indicate descending order. Redundant space characters are ignored. For example, location DESC , name .

string order_by = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public SearchAllResourcesRequest.Builder setOrderByBytes(ByteString value)

Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add DESC after the field name to indicate descending order. Redundant space characters are ignored. For example, location DESC , name .

string order_by = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setPageSize(int value)

public SearchAllResourcesRequest.Builder setPageSize(int value)

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchAllResourcesRequest.Builder setPageToken(String value)

Optional. If present, then retrieve 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 all other method parameters, must be identical to those in the previous call.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchAllResourcesRequest.Builder setPageTokenBytes(ByteString value)

Optional. If present, then retrieve 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 all other method parameters, must be identical to those in the previous call.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setQuery(String value)

public SearchAllResourcesRequest.Builder setQuery(String value)

Optional. The query statement.

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The query to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public SearchAllResourcesRequest.Builder setQueryBytes(ByteString value)

Optional. The query statement.

string query = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for query to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

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

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

setScope(String value)

public SearchAllResourcesRequest.Builder setScope(String value)

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

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

Parameter
Name Description
value String

The scope to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public SearchAllResourcesRequest.Builder setScopeBytes(ByteString value)

Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

  • Organization number (such as "organizations/123")
  • Folder number (such as "folders/1234")
  • Project number (such as "projects/12345")
  • Project ID (such as "projects/abc")

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

Parameter
Name Description
value ByteString

The bytes for scope to set.

Returns
Type Description
SearchAllResourcesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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