Class SearchEntriesRequest.Builder (1.39.0)

public static final class SearchEntriesRequest.Builder extends GeneratedMessageV3.Builder<SearchEntriesRequest.Builder> implements SearchEntriesRequestOrBuilder

Protobuf type google.cloud.dataplex.v1.SearchEntriesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchEntriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

build()

public SearchEntriesRequest build()
Returns
TypeDescription
SearchEntriesRequest

buildPartial()

public SearchEntriesRequest buildPartial()
Returns
TypeDescription
SearchEntriesRequest

clear()

public SearchEntriesRequest.Builder clear()
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchEntriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

clearName()

public SearchEntriesRequest.Builder clearName()

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
SearchEntriesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchEntriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

clearOrderBy()

public SearchEntriesRequest.Builder clearOrderBy()

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

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

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

clearPageSize()

public SearchEntriesRequest.Builder clearPageSize()

Optional. Pagination.

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

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

clearPageToken()

public SearchEntriesRequest.Builder clearPageToken()

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

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

clearQuery()

public SearchEntriesRequest.Builder clearQuery()

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

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

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

clearScope()

public SearchEntriesRequest.Builder clearScope()

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
SearchEntriesRequest.Builder

This builder for chaining.

clone()

public SearchEntriesRequest.Builder clone()
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchEntriesRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchEntriesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchEntriesRequest other)

public SearchEntriesRequest.Builder mergeFrom(SearchEntriesRequest other)
Parameter
NameDescription
otherSearchEntriesRequest
Returns
TypeDescription
SearchEntriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchEntriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchEntriesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchEntriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchEntriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

setName(String value)

public SearchEntriesRequest.Builder setName(String value)

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SearchEntriesRequest.Builder setNameBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public SearchEntriesRequest.Builder setOrderBy(String value)

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

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

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public SearchEntriesRequest.Builder setOrderByBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setPageSize(int value)

public SearchEntriesRequest.Builder setPageSize(int value)

Optional. Pagination.

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

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchEntriesRequest.Builder setPageToken(String value)

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

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchEntriesRequest.Builder setPageTokenBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setQuery(String value)

public SearchEntriesRequest.Builder setQuery(String value)

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

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

Parameter
NameDescription
valueString

The query to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public SearchEntriesRequest.Builder setQueryBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for query to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchEntriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides

setScope(String value)

public SearchEntriesRequest.Builder setScope(String value)

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

Parameter
NameDescription
valueString

The scope to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public SearchEntriesRequest.Builder setScopeBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for scope to set.

Returns
TypeDescription
SearchEntriesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchEntriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchEntriesRequest.Builder
Overrides