Class SearchEntriesRequest (1.37.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
TypeDescription
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchEntriesRequest getDefaultInstance()
Returns
TypeDescription
SearchEntriesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchEntriesRequest.Builder newBuilder()
Returns
TypeDescription
SearchEntriesRequest.Builder

newBuilder(SearchEntriesRequest prototype)

public static SearchEntriesRequest.Builder newBuilder(SearchEntriesRequest prototype)
Parameter
NameDescription
prototypeSearchEntriesRequest
Returns
TypeDescription
SearchEntriesRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchEntriesRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchEntriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchEntriesRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchEntriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchEntriesRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchEntriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchEntriesRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchEntriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchEntriesRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchEntriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchEntriesRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchEntriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchEntriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchEntriesRequest> parser()
Returns
TypeDescription
Parser<SearchEntriesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchEntriesRequest getDefaultInstanceForType()
Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
ByteString

The bytes for name.

getOrderBy()

public String getOrderBy()

Optional. Ordering of the results. Supported options to be added later.

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

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Ordering of the results. Supported options to be added later.

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

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Pagination.

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

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

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

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParserForType()

public Parser<SearchEntriesRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for query.

getScope()

public String getScope()

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

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

Returns
TypeDescription
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for scope.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchEntriesRequest.Builder newBuilderForType()
Returns
TypeDescription
SearchEntriesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchEntriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchEntriesRequest.Builder toBuilder()
Returns
TypeDescription
SearchEntriesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException