public static final class ListSearchedResultsRequest.Builder extends GeneratedMessage.Builder<ListSearchedResultsRequest.Builder> implements ListSearchedResultsRequestOrBuilderRequest message for the ListSearchedResults method.
Protobuf type google.cloud.chronicle.v1.ListSearchedResultsRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListSearchedResultsRequest.BuilderImplements
ListSearchedResultsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public ListSearchedResultsRequest build()| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest |
|
buildPartial()
public ListSearchedResultsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest |
|
clear()
public ListSearchedResultsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
|
clearOrderBy()
public ListSearchedResultsRequest.Builder clearOrderBy()Optional. The column to sort the results on. Example: "event_timestamp desc", "principal.hostname asc". Multi-columnar sorting is not supported.
string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListSearchedResultsRequest.Builder clearPageSize()Optional. The maximum number of results to return. The service may return fewer. If unspecified, at most 100 results will be returned. The maximum value is 1000.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListSearchedResultsRequest.Builder clearPageToken() Optional. A page token, received from a previous ListSearchedResults
call. Provide this to retrieve the subsequent page.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
clearParent()
public ListSearchedResultsRequest.Builder clearParent()Required. The parent SearchSession resource name. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
clearSkip()
public ListSearchedResultsRequest.Builder clearSkip()Optional. The number of results to skip before starting to return results. This field should not be used in conjunction with page_token.
int32 skip = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public ListSearchedResultsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getOrderBy()
public String getOrderBy()Optional. The column to sort the results on. Example: "event_timestamp desc", "principal.hostname asc". Multi-columnar sorting is not supported.
string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()Optional. The column to sort the results on. Example: "event_timestamp desc", "principal.hostname asc". Multi-columnar sorting is not supported.
string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public int getPageSize()Optional. The maximum number of results to return. The service may return fewer. If unspecified, at most 100 results will be returned. The maximum value is 1000.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken() Optional. A page token, received from a previous ListSearchedResults
call. Provide this to retrieve the subsequent page.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() Optional. A page token, received from a previous ListSearchedResults
call. Provide this to retrieve the subsequent page.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public String getParent()Required. The parent SearchSession resource name. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()Required. The parent SearchSession resource name. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getSkip()
public int getSkip()Optional. The number of results to skip before starting to return results. This field should not be used in conjunction with page_token.
int32 skip = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The skip. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListSearchedResultsRequest other)
public ListSearchedResultsRequest.Builder mergeFrom(ListSearchedResultsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListSearchedResultsRequest |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListSearchedResultsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListSearchedResultsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
|
setOrderBy(String value)
public ListSearchedResultsRequest.Builder setOrderBy(String value)Optional. The column to sort the results on. Example: "event_timestamp desc", "principal.hostname asc". Multi-columnar sorting is not supported.
string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListSearchedResultsRequest.Builder setOrderByBytes(ByteString value)Optional. The column to sort the results on. Example: "event_timestamp desc", "principal.hostname asc". Multi-columnar sorting is not supported.
string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListSearchedResultsRequest.Builder setPageSize(int value)Optional. The maximum number of results to return. The service may return fewer. If unspecified, at most 100 results will be returned. The maximum value is 1000.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListSearchedResultsRequest.Builder setPageToken(String value) Optional. A page token, received from a previous ListSearchedResults
call. Provide this to retrieve the subsequent page.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListSearchedResultsRequest.Builder setPageTokenBytes(ByteString value) Optional. A page token, received from a previous ListSearchedResults
call. Provide this to retrieve the subsequent page.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListSearchedResultsRequest.Builder setParent(String value)Required. The parent SearchSession resource name. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListSearchedResultsRequest.Builder setParentBytes(ByteString value)Required. The parent SearchSession resource name. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
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 |
ListSearchedResultsRequest.Builder |
This builder for chaining. |
setSkip(int value)
public ListSearchedResultsRequest.Builder setSkip(int value)Optional. The number of results to skip before starting to return results. This field should not be used in conjunction with page_token.
int32 skip = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe skip to set. |
| Returns | |
|---|---|
| Type | Description |
ListSearchedResultsRequest.Builder |
This builder for chaining. |