Class ListSearchedResultsRequest (0.41.0)

public final class ListSearchedResultsRequest extends GeneratedMessage implements ListSearchedResultsRequestOrBuilder

Request message for the ListSearchedResults method.

Protobuf type google.cloud.chronicle.v1.ListSearchedResultsRequest

Static Fields

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SKIP_FIELD_NUMBER

public static final int SKIP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListSearchedResultsRequest getDefaultInstance()
Returns
Type Description
ListSearchedResultsRequest

getDescriptor()

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

newBuilder()

public static ListSearchedResultsRequest.Builder newBuilder()
Returns
Type Description
ListSearchedResultsRequest.Builder

newBuilder(ListSearchedResultsRequest prototype)

public static ListSearchedResultsRequest.Builder newBuilder(ListSearchedResultsRequest prototype)
Parameter
Name Description
prototype ListSearchedResultsRequest
Returns
Type Description
ListSearchedResultsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListSearchedResultsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSearchedResultsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListSearchedResultsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListSearchedResultsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListSearchedResultsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListSearchedResultsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListSearchedResultsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSearchedResultsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListSearchedResultsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSearchedResultsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListSearchedResultsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListSearchedResultsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSearchedResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListSearchedResultsRequest> parser()
Returns
Type Description
Parser<ListSearchedResultsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListSearchedResultsRequest getDefaultInstanceForType()
Returns
Type Description
ListSearchedResultsRequest

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.

getParserForType()

public Parser<ListSearchedResultsRequest> getParserForType()
Returns
Type Description
Parser<ListSearchedResultsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListSearchedResultsRequest.Builder newBuilderForType()
Returns
Type Description
ListSearchedResultsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListSearchedResultsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListSearchedResultsRequest.Builder
Overrides

toBuilder()

public ListSearchedResultsRequest.Builder toBuilder()
Returns
Type Description
ListSearchedResultsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException