Interface SearchEntriesRequestOrBuilder (1.52.0)

public interface SearchEntriesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getName()

public abstract String getName()

Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.

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

Returns
Type Description
ByteString

The bytes for name.

getOrderBy()

public abstract String getOrderBy()

Optional. Specifies the ordering of results.

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

Optional. Specifies the ordering of results.

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

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getQuery()

public abstract String getQuery()

Required. The query against which entries in scope should be matched.

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

Returns
Type Description
String

The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

Required. The query against which entries in scope should be matched.

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

Returns
Type Description
ByteString

The bytes for query.

getScope()

public abstract String getScope()

Optional. The scope under which the search should be operating. It must either be organizations/<org_id> or projects/<project_ref>. If it is unspecified, it defaults to the organization where the project provided in name is located.

string scope = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The scope.

getScopeBytes()

public abstract ByteString getScopeBytes()

Optional. The scope under which the search should be operating. It must either be organizations/<org_id> or projects/<project_ref>. If it is unspecified, it defaults to the organization where the project provided in name is located.

string scope = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for scope.