Class SearchCatalogRequest.Builder (1.11.0)

public static final class SearchCatalogRequest.Builder extends GeneratedMessageV3.Builder<SearchCatalogRequest.Builder> implements SearchCatalogRequestOrBuilder

Request message for SearchCatalog.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SearchCatalogRequest build()
Returns
TypeDescription
SearchCatalogRequest

buildPartial()

public SearchCatalogRequest buildPartial()
Returns
TypeDescription
SearchCatalogRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public SearchCatalogRequest.Builder clearOrderBy()

Specifies the order of results. Currently supported case-sensitive values are:

  • relevance that can only be descending
  • last_modified_timestamp [asc|desc] with descending (desc) as default
  • default that can only be descending If this parameter is omitted, it defaults to the descending relevance.

string order_by = 5;

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

clearPageSize()

public SearchCatalogRequest.Builder clearPageSize()

Number of results to return in a single search page. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.

int32 page_size = 2;

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

clearPageToken()

public SearchCatalogRequest.Builder clearPageToken()

Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.

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

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

clearQuery()

public SearchCatalogRequest.Builder clearQuery()

Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple xyz or qualified by predicates:

  • name:x
  • column:y
  • description:z

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

clearScope()

public SearchCatalogRequest.Builder clearScope()

Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SearchCatalogRequest.Builder

clone()

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

getDefaultInstanceForType()

public SearchCatalogRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchCatalogRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getOrderBy()

public String getOrderBy()

Specifies the order of results. Currently supported case-sensitive values are:

  • relevance that can only be descending
  • last_modified_timestamp [asc|desc] with descending (desc) as default
  • default that can only be descending If this parameter is omitted, it defaults to the descending relevance.

string order_by = 5;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Specifies the order of results. Currently supported case-sensitive values are:

  • relevance that can only be descending
  • last_modified_timestamp [asc|desc] with descending (desc) as default
  • default that can only be descending If this parameter is omitted, it defaults to the descending relevance.

string order_by = 5;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Number of results to return in a single search page. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.

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

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getQuery()

public String getQuery()

Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple xyz or qualified by predicates:

  • name:x
  • column:y
  • description:z

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple xyz or qualified by predicates:

  • name:x
  • column:y
  • description:z

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for query.

getScope()

public SearchCatalogRequest.Scope getScope()

Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SearchCatalogRequest.Scope

The scope.

getScopeBuilder()

public SearchCatalogRequest.Scope.Builder getScopeBuilder()

Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

getScopeOrBuilder()

public SearchCatalogRequest.ScopeOrBuilder getScopeOrBuilder()

Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SearchCatalogRequest.ScopeOrBuilder

hasScope()

public boolean hasScope()

Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the scope field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchCatalogRequest other)

public SearchCatalogRequest.Builder mergeFrom(SearchCatalogRequest other)
Parameter
NameDescription
otherSearchCatalogRequest
Returns
TypeDescription
SearchCatalogRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeScope(SearchCatalogRequest.Scope value)

public SearchCatalogRequest.Builder mergeScope(SearchCatalogRequest.Scope value)

Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueSearchCatalogRequest.Scope
Returns
TypeDescription
SearchCatalogRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setOrderBy(String value)

public SearchCatalogRequest.Builder setOrderBy(String value)

Specifies the order of results. Currently supported case-sensitive values are:

  • relevance that can only be descending
  • last_modified_timestamp [asc|desc] with descending (desc) as default
  • default that can only be descending If this parameter is omitted, it defaults to the descending relevance.

string order_by = 5;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public SearchCatalogRequest.Builder setOrderByBytes(ByteString value)

Specifies the order of results. Currently supported case-sensitive values are:

  • relevance that can only be descending
  • last_modified_timestamp [asc|desc] with descending (desc) as default
  • default that can only be descending If this parameter is omitted, it defaults to the descending relevance.

string order_by = 5;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

setPageSize(int value)

public SearchCatalogRequest.Builder setPageSize(int value)

Number of results to return in a single search page. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchCatalogRequest.Builder setPageToken(String value)

Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.

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

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchCatalogRequest.Builder setPageTokenBytes(ByteString value)

Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

setQuery(String value)

public SearchCatalogRequest.Builder setQuery(String value)

Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple xyz or qualified by predicates:

  • name:x
  • column:y
  • description:z

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The query to set.

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public SearchCatalogRequest.Builder setQueryBytes(ByteString value)

Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple xyz or qualified by predicates:

  • name:x
  • column:y
  • description:z

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for query to set.

Returns
TypeDescription
SearchCatalogRequest.Builder

This builder for chaining.

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

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

setScope(SearchCatalogRequest.Scope value)

public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope value)

Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueSearchCatalogRequest.Scope
Returns
TypeDescription
SearchCatalogRequest.Builder

setScope(SearchCatalogRequest.Scope.Builder builderForValue)

public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope.Builder builderForValue)

Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueSearchCatalogRequest.Scope.Builder
Returns
TypeDescription
SearchCatalogRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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