Class SearchEntriesRequest (1.53.0)

public final class SearchEntriesRequest extends GeneratedMessageV3 implements SearchEntriesRequestOrBuilder

Protobuf type google.cloud.dataplex.v1.SearchEntriesRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

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

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchEntriesRequest getDefaultInstance()
Returns
Type Description
SearchEntriesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SearchEntriesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchEntriesRequest getDefaultInstanceForType()
Returns
Type Description
SearchEntriesRequest

getName()

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

getParserForType()

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

getQuery()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchEntriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchEntriesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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