Class SearchCatalogRequest.Scope.Builder 

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

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

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

clearField(Descriptors.FieldDescriptor field)

public SearchCatalogRequest.Scope.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchCatalogRequest.Scope.Builder
Overrides

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

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

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchCatalogRequest.Scope.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchCatalogRequest.Scope.Builder
Overrides

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

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

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