Interface SearchAllResourcesRequestOrBuilder (3.2.17)

Version 3.2.17

• 3.45.0 (latest)
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.2-SNAPSHOT
• 3.6.0
• 3.4.1
• 3.3.1
• 3.2.17

public interface SearchAllResourcesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssetTypes(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the assetTypes.

getOrderBy()

public abstract 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, " foo , bar desc ".

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

Returns

Type	Description
String	The orderBy.

getOrderByBytes()

public abstract 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, " foo , bar desc ".

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

Returns

Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public abstract 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 abstract 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 abstract 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 abstract String getQuery()

Optional. The query statement.

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

Returns

Type	Description
String	The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

Optional. The query statement.

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

Returns

Type	Description
ByteString	The bytes for query.

getScope()

public abstract 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 abstract 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.