Class CatalogServiceClient (1.49.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entry and Aspect which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryTypeName name = EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]");
   EntryType response = catalogServiceClient.getEntryType(name);
 }

Note: close() needs to be called on the CatalogServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreateEntryType

Creates an EntryType

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEntryTypeAsync(CreateEntryTypeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createEntryTypeAsync(LocationName parent, EntryType entryType, String entryTypeId)

  • createEntryTypeAsync(String parent, EntryType entryType, String entryTypeId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEntryTypeOperationCallable()

  • createEntryTypeCallable()

UpdateEntryType

Updates a EntryType resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEntryTypeAsync(UpdateEntryTypeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateEntryTypeAsync(EntryType entryType, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateEntryTypeOperationCallable()

  • updateEntryTypeCallable()

DeleteEntryType

Deletes a EntryType resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEntryTypeAsync(DeleteEntryTypeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteEntryTypeAsync(EntryTypeName name)

  • deleteEntryTypeAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteEntryTypeOperationCallable()

  • deleteEntryTypeCallable()

ListEntryTypes

Lists EntryType resources in a project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEntryTypes(ListEntryTypesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEntryTypes(LocationName parent)

  • listEntryTypes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listEntryTypesPagedCallable()

  • listEntryTypesCallable()

GetEntryType

Retrieves a EntryType resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEntryType(GetEntryTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEntryType(EntryTypeName name)

  • getEntryType(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEntryTypeCallable()

CreateAspectType

Creates an AspectType

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAspectTypeAsync(CreateAspectTypeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createAspectTypeAsync(LocationName parent, AspectType aspectType, String aspectTypeId)

  • createAspectTypeAsync(String parent, AspectType aspectType, String aspectTypeId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAspectTypeOperationCallable()

  • createAspectTypeCallable()

UpdateAspectType

Updates a AspectType resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAspectTypeAsync(UpdateAspectTypeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateAspectTypeAsync(AspectType aspectType, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAspectTypeOperationCallable()

  • updateAspectTypeCallable()

DeleteAspectType

Deletes a AspectType resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAspectTypeAsync(DeleteAspectTypeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAspectTypeAsync(AspectTypeName name)

  • deleteAspectTypeAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAspectTypeOperationCallable()

  • deleteAspectTypeCallable()

ListAspectTypes

Lists AspectType resources in a project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAspectTypes(ListAspectTypesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAspectTypes(LocationName parent)

  • listAspectTypes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAspectTypesPagedCallable()

  • listAspectTypesCallable()

GetAspectType

Retrieves a AspectType resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAspectType(GetAspectTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAspectType(AspectTypeName name)

  • getAspectType(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAspectTypeCallable()

CreateEntryGroup

Creates an EntryGroup

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEntryGroupAsync(CreateEntryGroupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createEntryGroupAsync(LocationName parent, EntryGroup entryGroup, String entryGroupId)

  • createEntryGroupAsync(String parent, EntryGroup entryGroup, String entryGroupId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEntryGroupOperationCallable()

  • createEntryGroupCallable()

UpdateEntryGroup

Updates a EntryGroup resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEntryGroupAsync(UpdateEntryGroupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateEntryGroupAsync(EntryGroup entryGroup, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateEntryGroupOperationCallable()

  • updateEntryGroupCallable()

DeleteEntryGroup

Deletes a EntryGroup resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEntryGroupAsync(DeleteEntryGroupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteEntryGroupAsync(EntryGroupName name)

  • deleteEntryGroupAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteEntryGroupOperationCallable()

  • deleteEntryGroupCallable()

ListEntryGroups

Lists EntryGroup resources in a project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEntryGroups(ListEntryGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEntryGroups(LocationName parent)

  • listEntryGroups(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listEntryGroupsPagedCallable()

  • listEntryGroupsCallable()

GetEntryGroup

Retrieves a EntryGroup resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEntryGroup(GetEntryGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEntryGroup(EntryGroupName name)

  • getEntryGroup(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEntryGroupCallable()

CreateEntry

Creates an Entry.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEntry(CreateEntryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createEntry(EntryGroupName parent, Entry entry, String entryId)

  • createEntry(String parent, Entry entry, String entryId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEntryCallable()

UpdateEntry

Updates an Entry.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEntry(UpdateEntryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateEntry(Entry entry, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateEntryCallable()

DeleteEntry

Deletes an Entry.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEntry(DeleteEntryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEntry(EntryName name)

  • deleteEntry(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteEntryCallable()

ListEntries

Lists entries within an entry group.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEntries(ListEntriesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEntries(EntryGroupName parent)

  • listEntries(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listEntriesPagedCallable()

  • listEntriesCallable()

GetEntry

Gets a single entry.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEntry(GetEntryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEntry(EntryName name)

  • getEntry(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEntryCallable()

LookupEntry

Looks up a single entry.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • lookupEntry(LookupEntryRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • lookupEntryCallable()

SearchEntries

Searches for entries matching given query and scope.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchEntries(SearchEntriesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • searchEntries(String name, String query)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchEntriesPagedCallable()

  • searchEntriesCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CatalogServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CatalogServiceSettings catalogServiceSettings =
     CatalogServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CatalogServiceSettings catalogServiceSettings =
     CatalogServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CatalogServiceSettings catalogServiceSettings =
     CatalogServiceSettings.newHttpJsonBuilder().build();
 CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > CatalogServiceClient

Static Methods

create()

public static final CatalogServiceClient create()

Constructs an instance of CatalogServiceClient with default settings.

Returns
Type Description
CatalogServiceClient
Exceptions
Type Description
IOException

create(CatalogServiceSettings settings)

public static final CatalogServiceClient create(CatalogServiceSettings settings)

Constructs an instance of CatalogServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings CatalogServiceSettings
Returns
Type Description
CatalogServiceClient
Exceptions
Type Description
IOException

create(CatalogServiceStub stub)

public static final CatalogServiceClient create(CatalogServiceStub stub)

Constructs an instance of CatalogServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CatalogServiceSettings).

Parameter
Name Description
stub CatalogServiceStub
Returns
Type Description
CatalogServiceClient

Constructors

CatalogServiceClient(CatalogServiceSettings settings)

protected CatalogServiceClient(CatalogServiceSettings settings)

Constructs an instance of CatalogServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings CatalogServiceSettings

CatalogServiceClient(CatalogServiceStub stub)

protected CatalogServiceClient(CatalogServiceStub stub)
Parameter
Name Description
stub CatalogServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createAspectTypeAsync(CreateAspectTypeRequest request)

public final OperationFuture<AspectType,OperationMetadata> createAspectTypeAsync(CreateAspectTypeRequest request)

Creates an AspectType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateAspectTypeRequest request =
       CreateAspectTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAspectTypeId("aspectTypeId-423030675")
           .setAspectType(AspectType.newBuilder().build())
           .setValidateOnly(true)
           .build();
   AspectType response = catalogServiceClient.createAspectTypeAsync(request).get();
 }
Parameter
Name Description
request CreateAspectTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<AspectType,OperationMetadata>

createAspectTypeAsync(LocationName parent, AspectType aspectType, String aspectTypeId)

public final OperationFuture<AspectType,OperationMetadata> createAspectTypeAsync(LocationName parent, AspectType aspectType, String aspectTypeId)

Creates an AspectType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   AspectType aspectType = AspectType.newBuilder().build();
   String aspectTypeId = "aspectTypeId-423030675";
   AspectType response =
       catalogServiceClient.createAspectTypeAsync(parent, aspectType, aspectTypeId).get();
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
aspectType AspectType

Required. AspectType Resource
aspectTypeId String

Required. AspectType identifier.
Returns
Type Description
OperationFuture<AspectType,OperationMetadata>

createAspectTypeAsync(String parent, AspectType aspectType, String aspectTypeId)

public final OperationFuture<AspectType,OperationMetadata> createAspectTypeAsync(String parent, AspectType aspectType, String aspectTypeId)

Creates an AspectType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   AspectType aspectType = AspectType.newBuilder().build();
   String aspectTypeId = "aspectTypeId-423030675";
   AspectType response =
       catalogServiceClient.createAspectTypeAsync(parent, aspectType, aspectTypeId).get();
 }
Parameters
Name Description
parent String

Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
aspectType AspectType

Required. AspectType Resource
aspectTypeId String

Required. AspectType identifier.
Returns
Type Description
OperationFuture<AspectType,OperationMetadata>

createAspectTypeCallable()

public final UnaryCallable<CreateAspectTypeRequest,Operation> createAspectTypeCallable()

Creates an AspectType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateAspectTypeRequest request =
       CreateAspectTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAspectTypeId("aspectTypeId-423030675")
           .setAspectType(AspectType.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.createAspectTypeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateAspectTypeRequest,Operation>

createAspectTypeOperationCallable()

public final OperationCallable<CreateAspectTypeRequest,AspectType,OperationMetadata> createAspectTypeOperationCallable()

Creates an AspectType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateAspectTypeRequest request =
       CreateAspectTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAspectTypeId("aspectTypeId-423030675")
           .setAspectType(AspectType.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<AspectType, OperationMetadata> future =
       catalogServiceClient.createAspectTypeOperationCallable().futureCall(request);
   // Do something.
   AspectType response = future.get();
 }
Returns
Type Description
OperationCallable<CreateAspectTypeRequest,AspectType,OperationMetadata>

createEntry(CreateEntryRequest request)

public final Entry createEntry(CreateEntryRequest request)

Creates an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateEntryRequest request =
       CreateEntryRequest.newBuilder()
           .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .setEntryId("entryId-1591558867")
           .setEntry(Entry.newBuilder().build())
           .build();
   Entry response = catalogServiceClient.createEntry(request);
 }
Parameter
Name Description
request CreateEntryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Entry

createEntry(EntryGroupName parent, Entry entry, String entryId)

public final Entry createEntry(EntryGroupName parent, Entry entry, String entryId)

Creates an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   Entry entry = Entry.newBuilder().build();
   String entryId = "entryId-1591558867";
   Entry response = catalogServiceClient.createEntry(parent, entry, entryId);
 }
Parameters
Name Description
parent EntryGroupName

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
entry Entry

Required. Entry resource.
entryId String

Required. Entry identifier. It has to be unique within an Entry Group.

Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.

For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.

It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.

The maximum size of the field is 4000 characters.
Returns
Type Description
Entry

createEntry(String parent, Entry entry, String entryId)

public final Entry createEntry(String parent, Entry entry, String entryId)

Creates an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
   Entry entry = Entry.newBuilder().build();
   String entryId = "entryId-1591558867";
   Entry response = catalogServiceClient.createEntry(parent, entry, entryId);
 }
Parameters
Name Description
parent String

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
entry Entry

Required. Entry resource.
entryId String

Required. Entry identifier. It has to be unique within an Entry Group.

Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.

For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.

It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.

The maximum size of the field is 4000 characters.
Returns
Type Description
Entry

createEntryCallable()

public final UnaryCallable<CreateEntryRequest,Entry> createEntryCallable()

Creates an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateEntryRequest request =
       CreateEntryRequest.newBuilder()
           .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .setEntryId("entryId-1591558867")
           .setEntry(Entry.newBuilder().build())
           .build();
   ApiFuture<Entry> future = catalogServiceClient.createEntryCallable().futureCall(request);
   // Do something.
   Entry response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateEntryRequest,Entry>

createEntryGroupAsync(CreateEntryGroupRequest request)

public final OperationFuture<EntryGroup,OperationMetadata> createEntryGroupAsync(CreateEntryGroupRequest request)

Creates an EntryGroup

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateEntryGroupRequest request =
       CreateEntryGroupRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEntryGroupId("entryGroupId1228924712")
           .setEntryGroup(EntryGroup.newBuilder().build())
           .setValidateOnly(true)
           .build();
   EntryGroup response = catalogServiceClient.createEntryGroupAsync(request).get();
 }
Parameter
Name Description
request CreateEntryGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<EntryGroup,OperationMetadata>

createEntryGroupAsync(LocationName parent, EntryGroup entryGroup, String entryGroupId)

public final OperationFuture<EntryGroup,OperationMetadata> createEntryGroupAsync(LocationName parent, EntryGroup entryGroup, String entryGroupId)

Creates an EntryGroup

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   String entryGroupId = "entryGroupId1228924712";
   EntryGroup response =
       catalogServiceClient.createEntryGroupAsync(parent, entryGroup, entryGroupId).get();
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
entryGroup EntryGroup

Required. EntryGroup Resource
entryGroupId String

Required. EntryGroup identifier.
Returns
Type Description
OperationFuture<EntryGroup,OperationMetadata>

createEntryGroupAsync(String parent, EntryGroup entryGroup, String entryGroupId)

public final OperationFuture<EntryGroup,OperationMetadata> createEntryGroupAsync(String parent, EntryGroup entryGroup, String entryGroupId)

Creates an EntryGroup

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   String entryGroupId = "entryGroupId1228924712";
   EntryGroup response =
       catalogServiceClient.createEntryGroupAsync(parent, entryGroup, entryGroupId).get();
 }
Parameters
Name Description
parent String

Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
entryGroup EntryGroup

Required. EntryGroup Resource
entryGroupId String

Required. EntryGroup identifier.
Returns
Type Description
OperationFuture<EntryGroup,OperationMetadata>

createEntryGroupCallable()

public final UnaryCallable<CreateEntryGroupRequest,Operation> createEntryGroupCallable()

Creates an EntryGroup

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateEntryGroupRequest request =
       CreateEntryGroupRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEntryGroupId("entryGroupId1228924712")
           .setEntryGroup(EntryGroup.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.createEntryGroupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateEntryGroupRequest,Operation>

createEntryGroupOperationCallable()

public final OperationCallable<CreateEntryGroupRequest,EntryGroup,OperationMetadata> createEntryGroupOperationCallable()

Creates an EntryGroup

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateEntryGroupRequest request =
       CreateEntryGroupRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEntryGroupId("entryGroupId1228924712")
           .setEntryGroup(EntryGroup.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<EntryGroup, OperationMetadata> future =
       catalogServiceClient.createEntryGroupOperationCallable().futureCall(request);
   // Do something.
   EntryGroup response = future.get();
 }
Returns
Type Description
OperationCallable<CreateEntryGroupRequest,EntryGroup,OperationMetadata>

createEntryTypeAsync(CreateEntryTypeRequest request)

public final OperationFuture<EntryType,OperationMetadata> createEntryTypeAsync(CreateEntryTypeRequest request)

Creates an EntryType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateEntryTypeRequest request =
       CreateEntryTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEntryTypeId("entryTypeId-1105721081")
           .setEntryType(EntryType.newBuilder().build())
           .setValidateOnly(true)
           .build();
   EntryType response = catalogServiceClient.createEntryTypeAsync(request).get();
 }
Parameter
Name Description
request CreateEntryTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<EntryType,OperationMetadata>

createEntryTypeAsync(LocationName parent, EntryType entryType, String entryTypeId)

public final OperationFuture<EntryType,OperationMetadata> createEntryTypeAsync(LocationName parent, EntryType entryType, String entryTypeId)

Creates an EntryType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   EntryType entryType = EntryType.newBuilder().build();
   String entryTypeId = "entryTypeId-1105721081";
   EntryType response =
       catalogServiceClient.createEntryTypeAsync(parent, entryType, entryTypeId).get();
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
entryType EntryType

Required. EntryType Resource
entryTypeId String

Required. EntryType identifier.
Returns
Type Description
OperationFuture<EntryType,OperationMetadata>

createEntryTypeAsync(String parent, EntryType entryType, String entryTypeId)

public final OperationFuture<EntryType,OperationMetadata> createEntryTypeAsync(String parent, EntryType entryType, String entryTypeId)

Creates an EntryType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   EntryType entryType = EntryType.newBuilder().build();
   String entryTypeId = "entryTypeId-1105721081";
   EntryType response =
       catalogServiceClient.createEntryTypeAsync(parent, entryType, entryTypeId).get();
 }
Parameters
Name Description
parent String

Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
entryType EntryType

Required. EntryType Resource
entryTypeId String

Required. EntryType identifier.
Returns
Type Description
OperationFuture<EntryType,OperationMetadata>

createEntryTypeCallable()

public final UnaryCallable<CreateEntryTypeRequest,Operation> createEntryTypeCallable()

Creates an EntryType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateEntryTypeRequest request =
       CreateEntryTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEntryTypeId("entryTypeId-1105721081")
           .setEntryType(EntryType.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.createEntryTypeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateEntryTypeRequest,Operation>

createEntryTypeOperationCallable()

public final OperationCallable<CreateEntryTypeRequest,EntryType,OperationMetadata> createEntryTypeOperationCallable()

Creates an EntryType

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CreateEntryTypeRequest request =
       CreateEntryTypeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEntryTypeId("entryTypeId-1105721081")
           .setEntryType(EntryType.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<EntryType, OperationMetadata> future =
       catalogServiceClient.createEntryTypeOperationCallable().futureCall(request);
   // Do something.
   EntryType response = future.get();
 }
Returns
Type Description
OperationCallable<CreateEntryTypeRequest,EntryType,OperationMetadata>

deleteAspectTypeAsync(AspectTypeName name)

public final OperationFuture<Empty,OperationMetadata> deleteAspectTypeAsync(AspectTypeName name)

Deletes a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   AspectTypeName name = AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]");
   catalogServiceClient.deleteAspectTypeAsync(name).get();
 }
Parameter
Name Description
name AspectTypeName

Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteAspectTypeAsync(DeleteAspectTypeRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteAspectTypeAsync(DeleteAspectTypeRequest request)

Deletes a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteAspectTypeRequest request =
       DeleteAspectTypeRequest.newBuilder()
           .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
           .setEtag("etag3123477")
           .build();
   catalogServiceClient.deleteAspectTypeAsync(request).get();
 }
Parameter
Name Description
request DeleteAspectTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteAspectTypeAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteAspectTypeAsync(String name)

Deletes a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString();
   catalogServiceClient.deleteAspectTypeAsync(name).get();
 }
Parameter
Name Description
name String

Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteAspectTypeCallable()

public final UnaryCallable<DeleteAspectTypeRequest,Operation> deleteAspectTypeCallable()

Deletes a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteAspectTypeRequest request =
       DeleteAspectTypeRequest.newBuilder()
           .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.deleteAspectTypeCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteAspectTypeRequest,Operation>

deleteAspectTypeOperationCallable()

public final OperationCallable<DeleteAspectTypeRequest,Empty,OperationMetadata> deleteAspectTypeOperationCallable()

Deletes a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteAspectTypeRequest request =
       DeleteAspectTypeRequest.newBuilder()
           .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       catalogServiceClient.deleteAspectTypeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteAspectTypeRequest,Empty,OperationMetadata>

deleteEntry(DeleteEntryRequest request)

public final Entry deleteEntry(DeleteEntryRequest request)

Deletes an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteEntryRequest request =
       DeleteEntryRequest.newBuilder()
           .setName(
               EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
           .build();
   Entry response = catalogServiceClient.deleteEntry(request);
 }
Parameter
Name Description
request DeleteEntryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Entry

deleteEntry(EntryName name)

public final Entry deleteEntry(EntryName name)

Deletes an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   Entry response = catalogServiceClient.deleteEntry(name);
 }
Parameter
Name Description
name EntryName

Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Returns
Type Description
Entry

deleteEntry(String name)

public final Entry deleteEntry(String name)

Deletes an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
   Entry response = catalogServiceClient.deleteEntry(name);
 }
Parameter
Name Description
name String

Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Returns
Type Description
Entry

deleteEntryCallable()

public final UnaryCallable<DeleteEntryRequest,Entry> deleteEntryCallable()

Deletes an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteEntryRequest request =
       DeleteEntryRequest.newBuilder()
           .setName(
               EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
           .build();
   ApiFuture<Entry> future = catalogServiceClient.deleteEntryCallable().futureCall(request);
   // Do something.
   Entry response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteEntryRequest,Entry>

deleteEntryGroupAsync(DeleteEntryGroupRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteEntryGroupAsync(DeleteEntryGroupRequest request)

Deletes a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteEntryGroupRequest request =
       DeleteEntryGroupRequest.newBuilder()
           .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .setEtag("etag3123477")
           .build();
   catalogServiceClient.deleteEntryGroupAsync(request).get();
 }
Parameter
Name Description
request DeleteEntryGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEntryGroupAsync(EntryGroupName name)

public final OperationFuture<Empty,OperationMetadata> deleteEntryGroupAsync(EntryGroupName name)

Deletes a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   catalogServiceClient.deleteEntryGroupAsync(name).get();
 }
Parameter
Name Description
name EntryGroupName

Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEntryGroupAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteEntryGroupAsync(String name)

Deletes a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
   catalogServiceClient.deleteEntryGroupAsync(name).get();
 }
Parameter
Name Description
name String

Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEntryGroupCallable()

public final UnaryCallable<DeleteEntryGroupRequest,Operation> deleteEntryGroupCallable()

Deletes a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteEntryGroupRequest request =
       DeleteEntryGroupRequest.newBuilder()
           .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.deleteEntryGroupCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteEntryGroupRequest,Operation>

deleteEntryGroupOperationCallable()

public final OperationCallable<DeleteEntryGroupRequest,Empty,OperationMetadata> deleteEntryGroupOperationCallable()

Deletes a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteEntryGroupRequest request =
       DeleteEntryGroupRequest.newBuilder()
           .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       catalogServiceClient.deleteEntryGroupOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteEntryGroupRequest,Empty,OperationMetadata>

deleteEntryTypeAsync(DeleteEntryTypeRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteEntryTypeAsync(DeleteEntryTypeRequest request)

Deletes a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteEntryTypeRequest request =
       DeleteEntryTypeRequest.newBuilder()
           .setName(EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]").toString())
           .setEtag("etag3123477")
           .build();
   catalogServiceClient.deleteEntryTypeAsync(request).get();
 }
Parameter
Name Description
request DeleteEntryTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEntryTypeAsync(EntryTypeName name)

public final OperationFuture<Empty,OperationMetadata> deleteEntryTypeAsync(EntryTypeName name)

Deletes a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryTypeName name = EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]");
   catalogServiceClient.deleteEntryTypeAsync(name).get();
 }
Parameter
Name Description
name EntryTypeName

Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEntryTypeAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteEntryTypeAsync(String name)

Deletes a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]").toString();
   catalogServiceClient.deleteEntryTypeAsync(name).get();
 }
Parameter
Name Description
name String

Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEntryTypeCallable()

public final UnaryCallable<DeleteEntryTypeRequest,Operation> deleteEntryTypeCallable()

Deletes a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteEntryTypeRequest request =
       DeleteEntryTypeRequest.newBuilder()
           .setName(EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.deleteEntryTypeCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteEntryTypeRequest,Operation>

deleteEntryTypeOperationCallable()

public final OperationCallable<DeleteEntryTypeRequest,Empty,OperationMetadata> deleteEntryTypeOperationCallable()

Deletes a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   DeleteEntryTypeRequest request =
       DeleteEntryTypeRequest.newBuilder()
           .setName(EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]").toString())
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       catalogServiceClient.deleteEntryTypeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteEntryTypeRequest,Empty,OperationMetadata>

getAspectType(AspectTypeName name)

public final AspectType getAspectType(AspectTypeName name)

Retrieves a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   AspectTypeName name = AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]");
   AspectType response = catalogServiceClient.getAspectType(name);
 }
Parameter
Name Description
name AspectTypeName

Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Returns
Type Description
AspectType

getAspectType(GetAspectTypeRequest request)

public final AspectType getAspectType(GetAspectTypeRequest request)

Retrieves a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetAspectTypeRequest request =
       GetAspectTypeRequest.newBuilder()
           .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
           .build();
   AspectType response = catalogServiceClient.getAspectType(request);
 }
Parameter
Name Description
request GetAspectTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AspectType

getAspectType(String name)

public final AspectType getAspectType(String name)

Retrieves a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString();
   AspectType response = catalogServiceClient.getAspectType(name);
 }
Parameter
Name Description
name String

Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Returns
Type Description
AspectType

getAspectTypeCallable()

public final UnaryCallable<GetAspectTypeRequest,AspectType> getAspectTypeCallable()

Retrieves a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetAspectTypeRequest request =
       GetAspectTypeRequest.newBuilder()
           .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
           .build();
   ApiFuture<AspectType> future =
       catalogServiceClient.getAspectTypeCallable().futureCall(request);
   // Do something.
   AspectType response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAspectTypeRequest,AspectType>

getEntry(EntryName name)

public final Entry getEntry(EntryName name)

Gets a single entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   Entry response = catalogServiceClient.getEntry(name);
 }
Parameter
Name Description
name EntryName

Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Returns
Type Description
Entry

getEntry(GetEntryRequest request)

public final Entry getEntry(GetEntryRequest request)

Gets a single entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetEntryRequest request =
       GetEntryRequest.newBuilder()
           .setName(
               EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
           .setView(EntryView.forNumber(0))
           .addAllAspectTypes(new ArrayList<String>())
           .addAllPaths(new ArrayList<String>())
           .build();
   Entry response = catalogServiceClient.getEntry(request);
 }
Parameter
Name Description
request GetEntryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Entry

getEntry(String name)

public final Entry getEntry(String name)

Gets a single entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
   Entry response = catalogServiceClient.getEntry(name);
 }
Parameter
Name Description
name String

Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Returns
Type Description
Entry

getEntryCallable()

public final UnaryCallable<GetEntryRequest,Entry> getEntryCallable()

Gets a single entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetEntryRequest request =
       GetEntryRequest.newBuilder()
           .setName(
               EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
           .setView(EntryView.forNumber(0))
           .addAllAspectTypes(new ArrayList<String>())
           .addAllPaths(new ArrayList<String>())
           .build();
   ApiFuture<Entry> future = catalogServiceClient.getEntryCallable().futureCall(request);
   // Do something.
   Entry response = future.get();
 }
Returns
Type Description
UnaryCallable<GetEntryRequest,Entry>

getEntryGroup(EntryGroupName name)

public final EntryGroup getEntryGroup(EntryGroupName name)

Retrieves a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   EntryGroup response = catalogServiceClient.getEntryGroup(name);
 }
Parameter
Name Description
name EntryGroupName

Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
Returns
Type Description
EntryGroup

getEntryGroup(GetEntryGroupRequest request)

public final EntryGroup getEntryGroup(GetEntryGroupRequest request)

Retrieves a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetEntryGroupRequest request =
       GetEntryGroupRequest.newBuilder()
           .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .build();
   EntryGroup response = catalogServiceClient.getEntryGroup(request);
 }
Parameter
Name Description
request GetEntryGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
EntryGroup

getEntryGroup(String name)

public final EntryGroup getEntryGroup(String name)

Retrieves a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
   EntryGroup response = catalogServiceClient.getEntryGroup(name);
 }
Parameter
Name Description
name String

Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
Returns
Type Description
EntryGroup

getEntryGroupCallable()

public final UnaryCallable<GetEntryGroupRequest,EntryGroup> getEntryGroupCallable()

Retrieves a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetEntryGroupRequest request =
       GetEntryGroupRequest.newBuilder()
           .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .build();
   ApiFuture<EntryGroup> future =
       catalogServiceClient.getEntryGroupCallable().futureCall(request);
   // Do something.
   EntryGroup response = future.get();
 }
Returns
Type Description
UnaryCallable<GetEntryGroupRequest,EntryGroup>

getEntryType(EntryTypeName name)

public final EntryType getEntryType(EntryTypeName name)

Retrieves a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryTypeName name = EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]");
   EntryType response = catalogServiceClient.getEntryType(name);
 }
Parameter
Name Description
name EntryTypeName

Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
Returns
Type Description
EntryType

getEntryType(GetEntryTypeRequest request)

public final EntryType getEntryType(GetEntryTypeRequest request)

Retrieves a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetEntryTypeRequest request =
       GetEntryTypeRequest.newBuilder()
           .setName(EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]").toString())
           .build();
   EntryType response = catalogServiceClient.getEntryType(request);
 }
Parameter
Name Description
request GetEntryTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
EntryType

getEntryType(String name)

public final EntryType getEntryType(String name)

Retrieves a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]").toString();
   EntryType response = catalogServiceClient.getEntryType(name);
 }
Parameter
Name Description
name String

Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
Returns
Type Description
EntryType

getEntryTypeCallable()

public final UnaryCallable<GetEntryTypeRequest,EntryType> getEntryTypeCallable()

Retrieves a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetEntryTypeRequest request =
       GetEntryTypeRequest.newBuilder()
           .setName(EntryTypeName.of("[PROJECT]", "[LOCATION]", "[ENTRY_TYPE]").toString())
           .build();
   ApiFuture<EntryType> future = catalogServiceClient.getEntryTypeCallable().futureCall(request);
   // Do something.
   EntryType response = future.get();
 }
Returns
Type Description
UnaryCallable<GetEntryTypeRequest,EntryType>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = catalogServiceClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = catalogServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSettings()

public final CatalogServiceSettings getSettings()
Returns
Type Description
CatalogServiceSettings

getStub()

public CatalogServiceStub getStub()
Returns
Type Description
CatalogServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listAspectTypes(ListAspectTypesRequest request)

public final CatalogServiceClient.ListAspectTypesPagedResponse listAspectTypes(ListAspectTypesRequest request)

Lists AspectType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListAspectTypesRequest request =
       ListAspectTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (AspectType element : catalogServiceClient.listAspectTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListAspectTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CatalogServiceClient.ListAspectTypesPagedResponse

listAspectTypes(LocationName parent)

public final CatalogServiceClient.ListAspectTypesPagedResponse listAspectTypes(LocationName parent)

Lists AspectType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (AspectType element : catalogServiceClient.listAspectTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Returns
Type Description
CatalogServiceClient.ListAspectTypesPagedResponse

listAspectTypes(String parent)

public final CatalogServiceClient.ListAspectTypesPagedResponse listAspectTypes(String parent)

Lists AspectType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (AspectType element : catalogServiceClient.listAspectTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Returns
Type Description
CatalogServiceClient.ListAspectTypesPagedResponse

listAspectTypesCallable()

public final UnaryCallable<ListAspectTypesRequest,ListAspectTypesResponse> listAspectTypesCallable()

Lists AspectType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListAspectTypesRequest request =
       ListAspectTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListAspectTypesResponse response =
         catalogServiceClient.listAspectTypesCallable().call(request);
     for (AspectType element : response.getAspectTypesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListAspectTypesRequest,ListAspectTypesResponse>

listAspectTypesPagedCallable()

public final UnaryCallable<ListAspectTypesRequest,CatalogServiceClient.ListAspectTypesPagedResponse> listAspectTypesPagedCallable()

Lists AspectType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListAspectTypesRequest request =
       ListAspectTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<AspectType> future =
       catalogServiceClient.listAspectTypesPagedCallable().futureCall(request);
   // Do something.
   for (AspectType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListAspectTypesRequest,ListAspectTypesPagedResponse>

listEntries(EntryGroupName parent)

public final CatalogServiceClient.ListEntriesPagedResponse listEntries(EntryGroupName parent)

Lists entries within an entry group.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   for (Entry element : catalogServiceClient.listEntries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent EntryGroupName

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
Returns
Type Description
CatalogServiceClient.ListEntriesPagedResponse

listEntries(ListEntriesRequest request)

public final CatalogServiceClient.ListEntriesPagedResponse listEntries(ListEntriesRequest request)

Lists entries within an entry group.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntriesRequest request =
       ListEntriesRequest.newBuilder()
           .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Entry element : catalogServiceClient.listEntries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListEntriesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CatalogServiceClient.ListEntriesPagedResponse

listEntries(String parent)

public final CatalogServiceClient.ListEntriesPagedResponse listEntries(String parent)

Lists entries within an entry group.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
   for (Entry element : catalogServiceClient.listEntries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
Returns
Type Description
CatalogServiceClient.ListEntriesPagedResponse

listEntriesCallable()

public final UnaryCallable<ListEntriesRequest,ListEntriesResponse> listEntriesCallable()

Lists entries within an entry group.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntriesRequest request =
       ListEntriesRequest.newBuilder()
           .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListEntriesResponse response = catalogServiceClient.listEntriesCallable().call(request);
     for (Entry element : response.getEntriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListEntriesRequest,ListEntriesResponse>

listEntriesPagedCallable()

public final UnaryCallable<ListEntriesRequest,CatalogServiceClient.ListEntriesPagedResponse> listEntriesPagedCallable()

Lists entries within an entry group.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntriesRequest request =
       ListEntriesRequest.newBuilder()
           .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Entry> future = catalogServiceClient.listEntriesPagedCallable().futureCall(request);
   // Do something.
   for (Entry element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListEntriesRequest,ListEntriesPagedResponse>

listEntryGroups(ListEntryGroupsRequest request)

public final CatalogServiceClient.ListEntryGroupsPagedResponse listEntryGroups(ListEntryGroupsRequest request)

Lists EntryGroup resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntryGroupsRequest request =
       ListEntryGroupsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (EntryGroup element : catalogServiceClient.listEntryGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListEntryGroupsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CatalogServiceClient.ListEntryGroupsPagedResponse

listEntryGroups(LocationName parent)

public final CatalogServiceClient.ListEntryGroupsPagedResponse listEntryGroups(LocationName parent)

Lists EntryGroup resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (EntryGroup element : catalogServiceClient.listEntryGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Returns
Type Description
CatalogServiceClient.ListEntryGroupsPagedResponse

listEntryGroups(String parent)

public final CatalogServiceClient.ListEntryGroupsPagedResponse listEntryGroups(String parent)

Lists EntryGroup resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (EntryGroup element : catalogServiceClient.listEntryGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Returns
Type Description
CatalogServiceClient.ListEntryGroupsPagedResponse

listEntryGroupsCallable()

public final UnaryCallable<ListEntryGroupsRequest,ListEntryGroupsResponse> listEntryGroupsCallable()

Lists EntryGroup resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntryGroupsRequest request =
       ListEntryGroupsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEntryGroupsResponse response =
         catalogServiceClient.listEntryGroupsCallable().call(request);
     for (EntryGroup element : response.getEntryGroupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListEntryGroupsRequest,ListEntryGroupsResponse>

listEntryGroupsPagedCallable()

public final UnaryCallable<ListEntryGroupsRequest,CatalogServiceClient.ListEntryGroupsPagedResponse> listEntryGroupsPagedCallable()

Lists EntryGroup resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntryGroupsRequest request =
       ListEntryGroupsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<EntryGroup> future =
       catalogServiceClient.listEntryGroupsPagedCallable().futureCall(request);
   // Do something.
   for (EntryGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListEntryGroupsRequest,ListEntryGroupsPagedResponse>

listEntryTypes(ListEntryTypesRequest request)

public final CatalogServiceClient.ListEntryTypesPagedResponse listEntryTypes(ListEntryTypesRequest request)

Lists EntryType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntryTypesRequest request =
       ListEntryTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (EntryType element : catalogServiceClient.listEntryTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListEntryTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CatalogServiceClient.ListEntryTypesPagedResponse

listEntryTypes(LocationName parent)

public final CatalogServiceClient.ListEntryTypesPagedResponse listEntryTypes(LocationName parent)

Lists EntryType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (EntryType element : catalogServiceClient.listEntryTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Returns
Type Description
CatalogServiceClient.ListEntryTypesPagedResponse

listEntryTypes(String parent)

public final CatalogServiceClient.ListEntryTypesPagedResponse listEntryTypes(String parent)

Lists EntryType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (EntryType element : catalogServiceClient.listEntryTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
Returns
Type Description
CatalogServiceClient.ListEntryTypesPagedResponse

listEntryTypesCallable()

public final UnaryCallable<ListEntryTypesRequest,ListEntryTypesResponse> listEntryTypesCallable()

Lists EntryType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntryTypesRequest request =
       ListEntryTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEntryTypesResponse response =
         catalogServiceClient.listEntryTypesCallable().call(request);
     for (EntryType element : response.getEntryTypesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListEntryTypesRequest,ListEntryTypesResponse>

listEntryTypesPagedCallable()

public final UnaryCallable<ListEntryTypesRequest,CatalogServiceClient.ListEntryTypesPagedResponse> listEntryTypesPagedCallable()

Lists EntryType resources in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListEntryTypesRequest request =
       ListEntryTypesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<EntryType> future =
       catalogServiceClient.listEntryTypesPagedCallable().futureCall(request);
   // Do something.
   for (EntryType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListEntryTypesRequest,ListEntryTypesPagedResponse>

listLocations(ListLocationsRequest request)

public final CatalogServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : catalogServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CatalogServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = catalogServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,CatalogServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       catalogServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

lookupEntry(LookupEntryRequest request)

public final Entry lookupEntry(LookupEntryRequest request)

Looks up a single entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   LookupEntryRequest request =
       LookupEntryRequest.newBuilder()
           .setName("name3373707")
           .setView(EntryView.forNumber(0))
           .addAllAspectTypes(new ArrayList<String>())
           .addAllPaths(new ArrayList<String>())
           .setEntry(
               EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
           .build();
   Entry response = catalogServiceClient.lookupEntry(request);
 }
Parameter
Name Description
request LookupEntryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Entry

lookupEntryCallable()

public final UnaryCallable<LookupEntryRequest,Entry> lookupEntryCallable()

Looks up a single entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   LookupEntryRequest request =
       LookupEntryRequest.newBuilder()
           .setName("name3373707")
           .setView(EntryView.forNumber(0))
           .addAllAspectTypes(new ArrayList<String>())
           .addAllPaths(new ArrayList<String>())
           .setEntry(
               EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
           .build();
   ApiFuture<Entry> future = catalogServiceClient.lookupEntryCallable().futureCall(request);
   // Do something.
   Entry response = future.get();
 }
Returns
Type Description
UnaryCallable<LookupEntryRequest,Entry>

searchEntries(SearchEntriesRequest request)

public final CatalogServiceClient.SearchEntriesPagedResponse searchEntries(SearchEntriesRequest request)

Searches for entries matching given query and scope.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   SearchEntriesRequest request =
       SearchEntriesRequest.newBuilder()
           .setName("name3373707")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setScope("scope109264468")
           .build();
   for (SearchEntriesResult element : catalogServiceClient.searchEntries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request SearchEntriesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CatalogServiceClient.SearchEntriesPagedResponse

searchEntries(String name, String query)

public final CatalogServiceClient.SearchEntriesPagedResponse searchEntries(String name, String query)

Searches for entries matching given query and scope.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   String name = "name3373707";
   String query = "query107944136";
   for (SearchEntriesResult element :
       catalogServiceClient.searchEntries(name, query).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
name String

Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.
query String

Required. The query against which entries in scope should be matched.
Returns
Type Description
CatalogServiceClient.SearchEntriesPagedResponse

searchEntriesCallable()

public final UnaryCallable<SearchEntriesRequest,SearchEntriesResponse> searchEntriesCallable()

Searches for entries matching given query and scope.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   SearchEntriesRequest request =
       SearchEntriesRequest.newBuilder()
           .setName("name3373707")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setScope("scope109264468")
           .build();
   while (true) {
     SearchEntriesResponse response = catalogServiceClient.searchEntriesCallable().call(request);
     for (SearchEntriesResult element : response.getResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<SearchEntriesRequest,SearchEntriesResponse>

searchEntriesPagedCallable()

public final UnaryCallable<SearchEntriesRequest,CatalogServiceClient.SearchEntriesPagedResponse> searchEntriesPagedCallable()

Searches for entries matching given query and scope.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   SearchEntriesRequest request =
       SearchEntriesRequest.newBuilder()
           .setName("name3373707")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setScope("scope109264468")
           .build();
   ApiFuture<SearchEntriesResult> future =
       catalogServiceClient.searchEntriesPagedCallable().futureCall(request);
   // Do something.
   for (SearchEntriesResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<SearchEntriesRequest,SearchEntriesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAspectTypeAsync(AspectType aspectType, FieldMask updateMask)

public final OperationFuture<AspectType,OperationMetadata> updateAspectTypeAsync(AspectType aspectType, FieldMask updateMask)

Updates a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   AspectType aspectType = AspectType.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AspectType response =
       catalogServiceClient.updateAspectTypeAsync(aspectType, updateMask).get();
 }
Parameters
Name Description
aspectType AspectType

Required. AspectType Resource
updateMask FieldMask

Required. Mask of fields to update.
Returns
Type Description
OperationFuture<AspectType,OperationMetadata>

updateAspectTypeAsync(UpdateAspectTypeRequest request)

public final OperationFuture<AspectType,OperationMetadata> updateAspectTypeAsync(UpdateAspectTypeRequest request)

Updates a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateAspectTypeRequest request =
       UpdateAspectTypeRequest.newBuilder()
           .setAspectType(AspectType.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   AspectType response = catalogServiceClient.updateAspectTypeAsync(request).get();
 }
Parameter
Name Description
request UpdateAspectTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<AspectType,OperationMetadata>

updateAspectTypeCallable()

public final UnaryCallable<UpdateAspectTypeRequest,Operation> updateAspectTypeCallable()

Updates a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateAspectTypeRequest request =
       UpdateAspectTypeRequest.newBuilder()
           .setAspectType(AspectType.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.updateAspectTypeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateAspectTypeRequest,Operation>

updateAspectTypeOperationCallable()

public final OperationCallable<UpdateAspectTypeRequest,AspectType,OperationMetadata> updateAspectTypeOperationCallable()

Updates a AspectType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateAspectTypeRequest request =
       UpdateAspectTypeRequest.newBuilder()
           .setAspectType(AspectType.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<AspectType, OperationMetadata> future =
       catalogServiceClient.updateAspectTypeOperationCallable().futureCall(request);
   // Do something.
   AspectType response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateAspectTypeRequest,AspectType,OperationMetadata>

updateEntry(Entry entry, FieldMask updateMask)

public final Entry updateEntry(Entry entry, FieldMask updateMask)

Updates an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   Entry entry = Entry.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Entry response = catalogServiceClient.updateEntry(entry, updateMask);
 }
Parameters
Name Description
entry Entry

Required. Entry resource.
updateMask FieldMask

Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".

If the update_mask is empty, all modifiable fields present in the request will be updated.
Returns
Type Description
Entry

updateEntry(UpdateEntryRequest request)

public final Entry updateEntry(UpdateEntryRequest request)

Updates an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateEntryRequest request =
       UpdateEntryRequest.newBuilder()
           .setEntry(Entry.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAllowMissing(true)
           .setDeleteMissingAspects(true)
           .addAllAspectKeys(new ArrayList<String>())
           .build();
   Entry response = catalogServiceClient.updateEntry(request);
 }
Parameter
Name Description
request UpdateEntryRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Entry

updateEntryCallable()

public final UnaryCallable<UpdateEntryRequest,Entry> updateEntryCallable()

Updates an Entry.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateEntryRequest request =
       UpdateEntryRequest.newBuilder()
           .setEntry(Entry.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAllowMissing(true)
           .setDeleteMissingAspects(true)
           .addAllAspectKeys(new ArrayList<String>())
           .build();
   ApiFuture<Entry> future = catalogServiceClient.updateEntryCallable().futureCall(request);
   // Do something.
   Entry response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateEntryRequest,Entry>

updateEntryGroupAsync(EntryGroup entryGroup, FieldMask updateMask)

public final OperationFuture<EntryGroup,OperationMetadata> updateEntryGroupAsync(EntryGroup entryGroup, FieldMask updateMask)

Updates a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EntryGroup response =
       catalogServiceClient.updateEntryGroupAsync(entryGroup, updateMask).get();
 }
Parameters
Name Description
entryGroup EntryGroup

Required. EntryGroup Resource
updateMask FieldMask

Required. Mask of fields to update.
Returns
Type Description
OperationFuture<EntryGroup,OperationMetadata>

updateEntryGroupAsync(UpdateEntryGroupRequest request)

public final OperationFuture<EntryGroup,OperationMetadata> updateEntryGroupAsync(UpdateEntryGroupRequest request)

Updates a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateEntryGroupRequest request =
       UpdateEntryGroupRequest.newBuilder()
           .setEntryGroup(EntryGroup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   EntryGroup response = catalogServiceClient.updateEntryGroupAsync(request).get();
 }
Parameter
Name Description
request UpdateEntryGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<EntryGroup,OperationMetadata>

updateEntryGroupCallable()

public final UnaryCallable<UpdateEntryGroupRequest,Operation> updateEntryGroupCallable()

Updates a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateEntryGroupRequest request =
       UpdateEntryGroupRequest.newBuilder()
           .setEntryGroup(EntryGroup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.updateEntryGroupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateEntryGroupRequest,Operation>

updateEntryGroupOperationCallable()

public final OperationCallable<UpdateEntryGroupRequest,EntryGroup,OperationMetadata> updateEntryGroupOperationCallable()

Updates a EntryGroup resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateEntryGroupRequest request =
       UpdateEntryGroupRequest.newBuilder()
           .setEntryGroup(EntryGroup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<EntryGroup, OperationMetadata> future =
       catalogServiceClient.updateEntryGroupOperationCallable().futureCall(request);
   // Do something.
   EntryGroup response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateEntryGroupRequest,EntryGroup,OperationMetadata>

updateEntryTypeAsync(EntryType entryType, FieldMask updateMask)

public final OperationFuture<EntryType,OperationMetadata> updateEntryTypeAsync(EntryType entryType, FieldMask updateMask)

Updates a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   EntryType entryType = EntryType.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EntryType response = catalogServiceClient.updateEntryTypeAsync(entryType, updateMask).get();
 }
Parameters
Name Description
entryType EntryType

Required. EntryType Resource
updateMask FieldMask

Required. Mask of fields to update.
Returns
Type Description
OperationFuture<EntryType,OperationMetadata>

updateEntryTypeAsync(UpdateEntryTypeRequest request)

public final OperationFuture<EntryType,OperationMetadata> updateEntryTypeAsync(UpdateEntryTypeRequest request)

Updates a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateEntryTypeRequest request =
       UpdateEntryTypeRequest.newBuilder()
           .setEntryType(EntryType.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   EntryType response = catalogServiceClient.updateEntryTypeAsync(request).get();
 }
Parameter
Name Description
request UpdateEntryTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<EntryType,OperationMetadata>

updateEntryTypeCallable()

public final UnaryCallable<UpdateEntryTypeRequest,Operation> updateEntryTypeCallable()

Updates a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateEntryTypeRequest request =
       UpdateEntryTypeRequest.newBuilder()
           .setEntryType(EntryType.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       catalogServiceClient.updateEntryTypeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateEntryTypeRequest,Operation>

updateEntryTypeOperationCallable()

public final OperationCallable<UpdateEntryTypeRequest,EntryType,OperationMetadata> updateEntryTypeOperationCallable()

Updates a EntryType resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   UpdateEntryTypeRequest request =
       UpdateEntryTypeRequest.newBuilder()
           .setEntryType(EntryType.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<EntryType, OperationMetadata> future =
       catalogServiceClient.updateEntryTypeOperationCallable().futureCall(request);
   // Do something.
   EntryType response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateEntryTypeRequest,EntryType,OperationMetadata>