Class SearchCatalogRequest.Scope.Builder

Version 1.5.4

• 1.61.0 (latest)
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchCatalogRequest.Scope.Builder

Implements

SearchCatalogRequest.ScopeOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Parameter

Name	Description
values	Iterable<String> The includeOrgIds to add.

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Parameter

Name	Description
values	Iterable<String> The includeProjectIds to add.

Returns

Type	Description
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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Name	Description
values	Iterable<String> The restrictedLocations to add.

Returns

Type	Description
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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Parameter

Name	Description
value	String The includeOrgIds to add.

Returns

Type	Description
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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Parameter

Name	Description
value	ByteString The bytes of the includeOrgIds to add.

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Parameter

Name	Description
value	String The includeProjectIds to add.

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Parameter

Name	Description
value	ByteString The bytes of the includeProjectIds to add.

Returns

Type	Description
SearchCatalogRequest.Scope.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchCatalogRequest.Scope.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Name	Description
value	String The restrictedLocations to add.

Returns

Type	Description
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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Name	Description
value	ByteString The bytes of the restrictedLocations to add.

Returns

Type	Description
SearchCatalogRequest.Scope.Builder	This builder for chaining.

build()

public SearchCatalogRequest.Scope build()

Returns

Type	Description
SearchCatalogRequest.Scope

buildPartial()

public SearchCatalogRequest.Scope buildPartial()

Returns

Type	Description
SearchCatalogRequest.Scope

clear()

public SearchCatalogRequest.Scope.Builder clear()

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchCatalogRequest.Scope.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIncludeGcpPublicDatasets()

public SearchCatalogRequest.Scope.Builder clearIncludeGcpPublicDatasets()

If `true`, include Google Cloud Platform (GCP) public datasets in
 search results. By default, they are excluded.
 See [Google Cloud Public Datasets](/public-datasets) for more
 information.

bool include_gcp_public_datasets = 7;

Returns

Type	Description
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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Returns

Type	Description
SearchCatalogRequest.Scope.Builder	This builder for chaining.

clearIncludePublicTagTemplates()

public SearchCatalogRequest.Scope.Builder clearIncludePublicTagTemplates()

Optional. If `true`, include [public tag
 templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
 in the search results. By default, they are included only if you have
 explicit permissions on them to view them. For example, if you are the
 owner.
 Other scope fields, for example, ``include_org_ids``,
 still restrict the returned public tag templates and at least one of
 them is required.

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

Returns

Type	Description
SearchCatalogRequest.Scope.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchCatalogRequest.Scope.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Type	Description
SearchCatalogRequest.Scope.Builder	This builder for chaining.

clone()

public SearchCatalogRequest.Scope.Builder clone()

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchCatalogRequest.Scope getDefaultInstanceForType()

Returns

Type	Description
SearchCatalogRequest.Scope

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getIncludeGcpPublicDatasets()

public boolean getIncludeGcpPublicDatasets()

If `true`, include Google Cloud Platform (GCP) public datasets in
 search results. By default, they are excluded.
 See [Google Cloud Public Datasets](/public-datasets) for more
 information.

bool include_gcp_public_datasets = 7;

Returns

Type	Description
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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Returns

Type	Description
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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Returns

Type	Description
ProtocolStringList	A list containing the includeProjectIds.

getIncludePublicTagTemplates()

public boolean getIncludePublicTagTemplates()

Optional. If `true`, include [public tag
 templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
 in the search results. By default, they are included only if you have
 explicit permissions on them to view them. For example, if you are the
 owner.
 Other scope fields, for example, ``include_org_ids``,
 still restrict the returned public tag templates and at least one of
 them is required.

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

Returns

Type	Description
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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Name	Description
index	int The index of the element to return.

Returns

Type	Description
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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Name	Description
index	int The index of the value to return.

Returns

Type	Description
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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Type	Description
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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Type	Description
ProtocolStringList	A list containing the restrictedLocations.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchCatalogRequest.Scope other)

public SearchCatalogRequest.Scope.Builder mergeFrom(SearchCatalogRequest.Scope other)

Parameter

Name	Description
other	SearchCatalogRequest.Scope

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchCatalogRequest.Scope.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public SearchCatalogRequest.Scope.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchCatalogRequest.Scope.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public SearchCatalogRequest.Scope.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIncludeGcpPublicDatasets(boolean value)

public SearchCatalogRequest.Scope.Builder setIncludeGcpPublicDatasets(boolean value)

If `true`, include Google Cloud Platform (GCP) public datasets in
 search results. By default, they are excluded.
 See [Google Cloud Public Datasets](/public-datasets) for more
 information.

bool include_gcp_public_datasets = 7;

Parameter

Name	Description
value	boolean The includeGcpPublicDatasets to set.

Returns

Type	Description
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]
 (/resource-manager/docs/creating-managing-organization).

repeated string include_org_ids = 2;

Parameters

Name	Description
index	int The index to set the value at.
value	String The includeOrgIds to set.

Returns

Type	Description
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](/docs/overview/#projects).

repeated string include_project_ids = 3;

Parameters

Name	Description
index	int The index to set the value at.
value	String The includeProjectIds to set.

Returns

Type	Description
SearchCatalogRequest.Scope.Builder	This builder for chaining.

setIncludePublicTagTemplates(boolean value)

public SearchCatalogRequest.Scope.Builder setIncludePublicTagTemplates(boolean value)

Optional. If `true`, include [public tag
 templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
 in the search results. By default, they are included only if you have
 explicit permissions on them to view them. For example, if you are the
 owner.
 Other scope fields, for example, ``include_org_ids``,
 still restrict the returned public tag templates and at least one of
 them is required.

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

Parameter

Name	Description
value	boolean The includePublicTagTemplates to set.

Returns

Type	Description
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

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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](https://cloud.google.com/data-catalog/docs/concepts/regions#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

Name	Description
index	int The index to set the value at.
value	String The restrictedLocations to set.

Returns

Type	Description
SearchCatalogRequest.Scope.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchCatalogRequest.Scope.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)