Class SearchCatalogRequest.Scope.Builder (1.26.0)

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

The criteria that select the subspace used for query matching.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

Static Methods

getDescriptor()

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

Methods

addAllIncludeOrgIds(Iterable<String> values)

public SearchCatalogRequest.Scope.Builder addAllIncludeOrgIds(Iterable<String> values)

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Parameter
NameDescription
valuesIterable<String>

The includeOrgIds to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

addAllIncludeProjectIds(Iterable<String> values)

public SearchCatalogRequest.Scope.Builder addAllIncludeProjectIds(Iterable<String> values)

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Parameter
NameDescription
valuesIterable<String>

The includeProjectIds to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

addAllRestrictedLocations(Iterable<String> values)

public SearchCatalogRequest.Scope.Builder addAllRestrictedLocations(Iterable<String> values)

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesIterable<String>

The restrictedLocations to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

addIncludeOrgIds(String value)

public SearchCatalogRequest.Scope.Builder addIncludeOrgIds(String value)

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Parameter
NameDescription
valueString

The includeOrgIds to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

addIncludeOrgIdsBytes(ByteString value)

public SearchCatalogRequest.Scope.Builder addIncludeOrgIdsBytes(ByteString value)

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Parameter
NameDescription
valueByteString

The bytes of the includeOrgIds to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

addIncludeProjectIds(String value)

public SearchCatalogRequest.Scope.Builder addIncludeProjectIds(String value)

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Parameter
NameDescription
valueString

The includeProjectIds to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

addIncludeProjectIdsBytes(ByteString value)

public SearchCatalogRequest.Scope.Builder addIncludeProjectIdsBytes(ByteString value)

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Parameter
NameDescription
valueByteString

The bytes of the includeProjectIds to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addRestrictedLocations(String value)

public SearchCatalogRequest.Scope.Builder addRestrictedLocations(String value)

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The restrictedLocations to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

addRestrictedLocationsBytes(ByteString value)

public SearchCatalogRequest.Scope.Builder addRestrictedLocationsBytes(ByteString value)

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes of the restrictedLocations to add.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

build()

public SearchCatalogRequest.Scope build()
Returns
TypeDescription
SearchCatalogRequest.Scope

buildPartial()

public SearchCatalogRequest.Scope buildPartial()
Returns
TypeDescription
SearchCatalogRequest.Scope

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearIncludeGcpPublicDatasets()

public SearchCatalogRequest.Scope.Builder clearIncludeGcpPublicDatasets()

If true, include Google Cloud public datasets in search results. By default, they are excluded.

See Google Cloud Public Datasets for more information.

bool include_gcp_public_datasets = 7;

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

clearIncludeOrgIds()

public SearchCatalogRequest.Scope.Builder clearIncludeOrgIds()

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

clearIncludeProjectIds()

public SearchCatalogRequest.Scope.Builder clearIncludeProjectIds()

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

clearIncludePublicTagTemplates() (deprecated)

public SearchCatalogRequest.Scope.Builder clearIncludePublicTagTemplates()

Deprecated. google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates is deprecated. See google/cloud/datacatalog/v1/datacatalog.proto;l=677

Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.

bool include_public_tag_templates = 19 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRestrictedLocations()

public SearchCatalogRequest.Scope.Builder clearRestrictedLocations()

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

clearStarredOnly()

public SearchCatalogRequest.Scope.Builder clearStarredOnly()

Optional. If true, search only among starred entries.

By default, all results are returned, starred or not.

bool starred_only = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public SearchCatalogRequest.Scope getDefaultInstanceForType()
Returns
TypeDescription
SearchCatalogRequest.Scope

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIncludeGcpPublicDatasets()

public boolean getIncludeGcpPublicDatasets()

If true, include Google Cloud public datasets in search results. By default, they are excluded.

See Google Cloud Public Datasets for more information.

bool include_gcp_public_datasets = 7;

Returns
TypeDescription
boolean

The includeGcpPublicDatasets.

getIncludeOrgIds(int index)

public String getIncludeOrgIds(int index)

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The includeOrgIds at the given index.

getIncludeOrgIdsBytes(int index)

public ByteString getIncludeOrgIdsBytes(int index)

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the includeOrgIds at the given index.

getIncludeOrgIdsCount()

public int getIncludeOrgIdsCount()

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Returns
TypeDescription
int

The count of includeOrgIds.

getIncludeOrgIdsList()

public ProtocolStringList getIncludeOrgIdsList()

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the includeOrgIds.

getIncludeProjectIds(int index)

public String getIncludeProjectIds(int index)

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The includeProjectIds at the given index.

getIncludeProjectIdsBytes(int index)

public ByteString getIncludeProjectIdsBytes(int index)

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the includeProjectIds at the given index.

getIncludeProjectIdsCount()

public int getIncludeProjectIdsCount()

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Returns
TypeDescription
int

The count of includeProjectIds.

getIncludeProjectIdsList()

public ProtocolStringList getIncludeProjectIdsList()

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the includeProjectIds.

getIncludePublicTagTemplates() (deprecated)

public boolean getIncludePublicTagTemplates()

Deprecated. google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates is deprecated. See google/cloud/datacatalog/v1/datacatalog.proto;l=677

Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.

bool include_public_tag_templates = 19 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The includePublicTagTemplates.

getRestrictedLocations(int index)

public String getRestrictedLocations(int index)

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The restrictedLocations at the given index.

getRestrictedLocationsBytes(int index)

public ByteString getRestrictedLocationsBytes(int index)

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the restrictedLocations at the given index.

getRestrictedLocationsCount()

public int getRestrictedLocationsCount()

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of restrictedLocations.

getRestrictedLocationsList()

public ProtocolStringList getRestrictedLocationsList()

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the restrictedLocations.

getStarredOnly()

public boolean getStarredOnly()

Optional. If true, search only among starred entries.

By default, all results are returned, starred or not.

bool starred_only = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The starredOnly.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchCatalogRequest.Scope other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setIncludeGcpPublicDatasets(boolean value)

public SearchCatalogRequest.Scope.Builder setIncludeGcpPublicDatasets(boolean value)

If true, include Google Cloud public datasets in search results. By default, they are excluded.

See Google Cloud Public Datasets for more information.

bool include_gcp_public_datasets = 7;

Parameter
NameDescription
valueboolean

The includeGcpPublicDatasets to set.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

setIncludeOrgIds(int index, String value)

public SearchCatalogRequest.Scope.Builder setIncludeOrgIds(int index, String value)

The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

repeated string include_org_ids = 2;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The includeOrgIds to set.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

setIncludeProjectIds(int index, String value)

public SearchCatalogRequest.Scope.Builder setIncludeProjectIds(int index, String value)

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

repeated string include_project_ids = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The includeProjectIds to set.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

setIncludePublicTagTemplates(boolean value) (deprecated)

public SearchCatalogRequest.Scope.Builder setIncludePublicTagTemplates(boolean value)

Deprecated. google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates is deprecated. See google/cloud/datacatalog/v1/datacatalog.proto;l=677

Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.

bool include_public_tag_templates = 19 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueboolean

The includePublicTagTemplates to set.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

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

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

setRestrictedLocations(int index, String value)

public SearchCatalogRequest.Scope.Builder setRestrictedLocations(int index, String value)

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn't one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The restrictedLocations to set.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

setStarredOnly(boolean value)

public SearchCatalogRequest.Scope.Builder setStarredOnly(boolean value)

Optional. If true, search only among starred entries.

By default, all results are returned, starred or not.

bool starred_only = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueboolean

The starredOnly to set.

Returns
TypeDescription
SearchCatalogRequest.Scope.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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