com.google.cloud.dataplex.v1

Class CatalogServiceClient

java.lang.Object

com.google.cloud.dataplex.v1.CatalogServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class CatalogServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogServiceClient.ListAspectTypesFixedSizeCollection
static class	CatalogServiceClient.ListAspectTypesPage
static class	CatalogServiceClient.ListAspectTypesPagedResponse
static class	CatalogServiceClient.ListEntriesFixedSizeCollection
static class	CatalogServiceClient.ListEntriesPage
static class	CatalogServiceClient.ListEntriesPagedResponse
static class	CatalogServiceClient.ListEntryGroupsFixedSizeCollection
static class	CatalogServiceClient.ListEntryGroupsPage
static class	CatalogServiceClient.ListEntryGroupsPagedResponse
static class	CatalogServiceClient.ListEntryTypesFixedSizeCollection
static class	CatalogServiceClient.ListEntryTypesPage
static class	CatalogServiceClient.ListEntryTypesPagedResponse
static class	CatalogServiceClient.ListLocationsFixedSizeCollection
static class	CatalogServiceClient.ListLocationsPage
static class	CatalogServiceClient.ListLocationsPagedResponse
static class	CatalogServiceClient.SearchEntriesFixedSizeCollection
static class	CatalogServiceClient.SearchEntriesPage
static class	CatalogServiceClient.SearchEntriesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CatalogServiceClient(CatalogServiceSettings settings) Constructs an instance of CatalogServiceClient, using the given settings.
protected	CatalogServiceClient(CatalogServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static CatalogServiceClient	create() Constructs an instance of CatalogServiceClient with default settings.
static CatalogServiceClient	create(CatalogServiceSettings settings) Constructs an instance of CatalogServiceClient, using the given settings.
static CatalogServiceClient	create(CatalogServiceStub stub) Constructs an instance of CatalogServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<AspectType,OperationMetadata>	createAspectTypeAsync(CreateAspectTypeRequest request) Creates an AspectType
com.google.api.gax.longrunning.OperationFuture<AspectType,OperationMetadata>	createAspectTypeAsync(LocationName parent, AspectType aspectType, String aspectTypeId) Creates an AspectType
com.google.api.gax.longrunning.OperationFuture<AspectType,OperationMetadata>	createAspectTypeAsync(String parent, AspectType aspectType, String aspectTypeId) Creates an AspectType
com.google.api.gax.rpc.UnaryCallable<CreateAspectTypeRequest,com.google.longrunning.Operation>	createAspectTypeCallable() Creates an AspectType
com.google.api.gax.rpc.OperationCallable<CreateAspectTypeRequest,AspectType,OperationMetadata>	createAspectTypeOperationCallable() Creates an AspectType
Entry	createEntry(CreateEntryRequest request) Creates an Entry.
Entry	createEntry(EntryGroupName parent, Entry entry, String entryId) Creates an Entry.
Entry	createEntry(String parent, Entry entry, String entryId) Creates an Entry.
com.google.api.gax.rpc.UnaryCallable<CreateEntryRequest,Entry>	createEntryCallable() Creates an Entry.
com.google.api.gax.longrunning.OperationFuture<EntryGroup,OperationMetadata>	createEntryGroupAsync(CreateEntryGroupRequest request) Creates an EntryGroup
com.google.api.gax.longrunning.OperationFuture<EntryGroup,OperationMetadata>	createEntryGroupAsync(LocationName parent, EntryGroup entryGroup, String entryGroupId) Creates an EntryGroup
com.google.api.gax.longrunning.OperationFuture<EntryGroup,OperationMetadata>	createEntryGroupAsync(String parent, EntryGroup entryGroup, String entryGroupId) Creates an EntryGroup
com.google.api.gax.rpc.UnaryCallable<CreateEntryGroupRequest,com.google.longrunning.Operation>	createEntryGroupCallable() Creates an EntryGroup
com.google.api.gax.rpc.OperationCallable<CreateEntryGroupRequest,EntryGroup,OperationMetadata>	createEntryGroupOperationCallable() Creates an EntryGroup
com.google.api.gax.longrunning.OperationFuture<EntryType,OperationMetadata>	createEntryTypeAsync(CreateEntryTypeRequest request) Creates an EntryType
com.google.api.gax.longrunning.OperationFuture<EntryType,OperationMetadata>	createEntryTypeAsync(LocationName parent, EntryType entryType, String entryTypeId) Creates an EntryType
com.google.api.gax.longrunning.OperationFuture<EntryType,OperationMetadata>	createEntryTypeAsync(String parent, EntryType entryType, String entryTypeId) Creates an EntryType
com.google.api.gax.rpc.UnaryCallable<CreateEntryTypeRequest,com.google.longrunning.Operation>	createEntryTypeCallable() Creates an EntryType
com.google.api.gax.rpc.OperationCallable<CreateEntryTypeRequest,EntryType,OperationMetadata>	createEntryTypeOperationCallable() Creates an EntryType
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteAspectTypeAsync(AspectTypeName name) Deletes a AspectType resource.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteAspectTypeAsync(DeleteAspectTypeRequest request) Deletes a AspectType resource.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteAspectTypeAsync(String name) Deletes a AspectType resource.
com.google.api.gax.rpc.UnaryCallable<DeleteAspectTypeRequest,com.google.longrunning.Operation>	deleteAspectTypeCallable() Deletes a AspectType resource.
com.google.api.gax.rpc.OperationCallable<DeleteAspectTypeRequest,com.google.protobuf.Empty,OperationMetadata>	deleteAspectTypeOperationCallable() Deletes a AspectType resource.
Entry	deleteEntry(DeleteEntryRequest request) Deletes an Entry.
Entry	deleteEntry(EntryName name) Deletes an Entry.
Entry	deleteEntry(String name) Deletes an Entry.
com.google.api.gax.rpc.UnaryCallable<DeleteEntryRequest,Entry>	deleteEntryCallable() Deletes an Entry.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteEntryGroupAsync(DeleteEntryGroupRequest request) Deletes a EntryGroup resource.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteEntryGroupAsync(EntryGroupName name) Deletes a EntryGroup resource.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteEntryGroupAsync(String name) Deletes a EntryGroup resource.
com.google.api.gax.rpc.UnaryCallable<DeleteEntryGroupRequest,com.google.longrunning.Operation>	deleteEntryGroupCallable() Deletes a EntryGroup resource.
com.google.api.gax.rpc.OperationCallable<DeleteEntryGroupRequest,com.google.protobuf.Empty,OperationMetadata>	deleteEntryGroupOperationCallable() Deletes a EntryGroup resource.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteEntryTypeAsync(DeleteEntryTypeRequest request) Deletes a EntryType resource.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteEntryTypeAsync(EntryTypeName name) Deletes a EntryType resource.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteEntryTypeAsync(String name) Deletes a EntryType resource.
com.google.api.gax.rpc.UnaryCallable<DeleteEntryTypeRequest,com.google.longrunning.Operation>	deleteEntryTypeCallable() Deletes a EntryType resource.
com.google.api.gax.rpc.OperationCallable<DeleteEntryTypeRequest,com.google.protobuf.Empty,OperationMetadata>	deleteEntryTypeOperationCallable() Deletes a EntryType resource.
AspectType	getAspectType(AspectTypeName name) Retrieves a AspectType resource.
AspectType	getAspectType(GetAspectTypeRequest request) Retrieves a AspectType resource.
AspectType	getAspectType(String name) Retrieves a AspectType resource.
com.google.api.gax.rpc.UnaryCallable<GetAspectTypeRequest,AspectType>	getAspectTypeCallable() Retrieves a AspectType resource.
Entry	getEntry(EntryName name) Gets a single entry.
Entry	getEntry(GetEntryRequest request) Gets a single entry.
Entry	getEntry(String name) Gets a single entry.
com.google.api.gax.rpc.UnaryCallable<GetEntryRequest,Entry>	getEntryCallable() Gets a single entry.
EntryGroup	getEntryGroup(EntryGroupName name) Retrieves a EntryGroup resource.
EntryGroup	getEntryGroup(GetEntryGroupRequest request) Retrieves a EntryGroup resource.
EntryGroup	getEntryGroup(String name) Retrieves a EntryGroup resource.
com.google.api.gax.rpc.UnaryCallable<GetEntryGroupRequest,EntryGroup>	getEntryGroupCallable() Retrieves a EntryGroup resource.
EntryType	getEntryType(EntryTypeName name) Retrieves a EntryType resource.
EntryType	getEntryType(GetEntryTypeRequest request) Retrieves a EntryType resource.
EntryType	getEntryType(String name) Retrieves a EntryType resource.
com.google.api.gax.rpc.UnaryCallable<GetEntryTypeRequest,EntryType>	getEntryTypeCallable() Retrieves a EntryType resource.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.cloud.location.Location	getLocation(com.google.cloud.location.GetLocationRequest request) Gets information about a location.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationCallable() Gets information about a location.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
CatalogServiceSettings	getSettings()
CatalogServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
CatalogServiceClient.ListAspectTypesPagedResponse	listAspectTypes(ListAspectTypesRequest request) Lists AspectType resources in a project and location.
CatalogServiceClient.ListAspectTypesPagedResponse	listAspectTypes(LocationName parent) Lists AspectType resources in a project and location.
CatalogServiceClient.ListAspectTypesPagedResponse	listAspectTypes(String parent) Lists AspectType resources in a project and location.
com.google.api.gax.rpc.UnaryCallable<ListAspectTypesRequest,ListAspectTypesResponse>	listAspectTypesCallable() Lists AspectType resources in a project and location.
com.google.api.gax.rpc.UnaryCallable<ListAspectTypesRequest,CatalogServiceClient.ListAspectTypesPagedResponse>	listAspectTypesPagedCallable() Lists AspectType resources in a project and location.
CatalogServiceClient.ListEntriesPagedResponse	listEntries(EntryGroupName parent) Lists entries within an entry group.
CatalogServiceClient.ListEntriesPagedResponse	listEntries(ListEntriesRequest request) Lists entries within an entry group.
CatalogServiceClient.ListEntriesPagedResponse	listEntries(String parent) Lists entries within an entry group.
com.google.api.gax.rpc.UnaryCallable<ListEntriesRequest,ListEntriesResponse>	listEntriesCallable() Lists entries within an entry group.
com.google.api.gax.rpc.UnaryCallable<ListEntriesRequest,CatalogServiceClient.ListEntriesPagedResponse>	listEntriesPagedCallable() Lists entries within an entry group.
CatalogServiceClient.ListEntryGroupsPagedResponse	listEntryGroups(ListEntryGroupsRequest request) Lists EntryGroup resources in a project and location.
CatalogServiceClient.ListEntryGroupsPagedResponse	listEntryGroups(LocationName parent) Lists EntryGroup resources in a project and location.
CatalogServiceClient.ListEntryGroupsPagedResponse	listEntryGroups(String parent) Lists EntryGroup resources in a project and location.
com.google.api.gax.rpc.UnaryCallable<ListEntryGroupsRequest,ListEntryGroupsResponse>	listEntryGroupsCallable() Lists EntryGroup resources in a project and location.
com.google.api.gax.rpc.UnaryCallable<ListEntryGroupsRequest,CatalogServiceClient.ListEntryGroupsPagedResponse>	listEntryGroupsPagedCallable() Lists EntryGroup resources in a project and location.
CatalogServiceClient.ListEntryTypesPagedResponse	listEntryTypes(ListEntryTypesRequest request) Lists EntryType resources in a project and location.
CatalogServiceClient.ListEntryTypesPagedResponse	listEntryTypes(LocationName parent) Lists EntryType resources in a project and location.
CatalogServiceClient.ListEntryTypesPagedResponse	listEntryTypes(String parent) Lists EntryType resources in a project and location.
com.google.api.gax.rpc.UnaryCallable<ListEntryTypesRequest,ListEntryTypesResponse>	listEntryTypesCallable() Lists EntryType resources in a project and location.
com.google.api.gax.rpc.UnaryCallable<ListEntryTypesRequest,CatalogServiceClient.ListEntryTypesPagedResponse>	listEntryTypesPagedCallable() Lists EntryType resources in a project and location.
CatalogServiceClient.ListLocationsPagedResponse	listLocations(com.google.cloud.location.ListLocationsRequest request) Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>	listLocationsCallable() Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,CatalogServiceClient.ListLocationsPagedResponse>	listLocationsPagedCallable() Lists information about the supported locations for this service.
Entry	lookupEntry(LookupEntryRequest request) Looks up a single entry.
com.google.api.gax.rpc.UnaryCallable<LookupEntryRequest,Entry>	lookupEntryCallable() Looks up a single entry.
CatalogServiceClient.SearchEntriesPagedResponse	searchEntries(SearchEntriesRequest request) Searches for entries matching given query and scope.
CatalogServiceClient.SearchEntriesPagedResponse	searchEntries(String name, String query) Searches for entries matching given query and scope.
com.google.api.gax.rpc.UnaryCallable<SearchEntriesRequest,SearchEntriesResponse>	searchEntriesCallable() Searches for entries matching given query and scope.
com.google.api.gax.rpc.UnaryCallable<SearchEntriesRequest,CatalogServiceClient.SearchEntriesPagedResponse>	searchEntriesPagedCallable() Searches for entries matching given query and scope.
void	shutdown()
void	shutdownNow()
com.google.api.gax.longrunning.OperationFuture<AspectType,OperationMetadata>	updateAspectTypeAsync(AspectType aspectType, com.google.protobuf.FieldMask updateMask) Updates a AspectType resource.
com.google.api.gax.longrunning.OperationFuture<AspectType,OperationMetadata>	updateAspectTypeAsync(UpdateAspectTypeRequest request) Updates a AspectType resource.
com.google.api.gax.rpc.UnaryCallable<UpdateAspectTypeRequest,com.google.longrunning.Operation>	updateAspectTypeCallable() Updates a AspectType resource.
com.google.api.gax.rpc.OperationCallable<UpdateAspectTypeRequest,AspectType,OperationMetadata>	updateAspectTypeOperationCallable() Updates a AspectType resource.
Entry	updateEntry(Entry entry, com.google.protobuf.FieldMask updateMask) Updates an Entry.
Entry	updateEntry(UpdateEntryRequest request) Updates an Entry.
com.google.api.gax.rpc.UnaryCallable<UpdateEntryRequest,Entry>	updateEntryCallable() Updates an Entry.
com.google.api.gax.longrunning.OperationFuture<EntryGroup,OperationMetadata>	updateEntryGroupAsync(EntryGroup entryGroup, com.google.protobuf.FieldMask updateMask) Updates a EntryGroup resource.
com.google.api.gax.longrunning.OperationFuture<EntryGroup,OperationMetadata>	updateEntryGroupAsync(UpdateEntryGroupRequest request) Updates a EntryGroup resource.
com.google.api.gax.rpc.UnaryCallable<UpdateEntryGroupRequest,com.google.longrunning.Operation>	updateEntryGroupCallable() Updates a EntryGroup resource.
com.google.api.gax.rpc.OperationCallable<UpdateEntryGroupRequest,EntryGroup,OperationMetadata>	updateEntryGroupOperationCallable() Updates a EntryGroup resource.
com.google.api.gax.longrunning.OperationFuture<EntryType,OperationMetadata>	updateEntryTypeAsync(EntryType entryType, com.google.protobuf.FieldMask updateMask) Updates a EntryType resource.
com.google.api.gax.longrunning.OperationFuture<EntryType,OperationMetadata>	updateEntryTypeAsync(UpdateEntryTypeRequest request) Updates a EntryType resource.
com.google.api.gax.rpc.UnaryCallable<UpdateEntryTypeRequest,com.google.longrunning.Operation>	updateEntryTypeCallable() Updates a EntryType resource.
com.google.api.gax.rpc.OperationCallable<UpdateEntryTypeRequest,EntryType,OperationMetadata>	updateEntryTypeOperationCallable() Updates a EntryType resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CatalogServiceClient

protected CatalogServiceClient(CatalogServiceSettings settings)
                        throws IOException

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.

Throws:

IOException

CatalogServiceClient

protected CatalogServiceClient(CatalogServiceStub stub)

Method Detail

create

public static final CatalogServiceClient create()
                                         throws IOException

Constructs an instance of CatalogServiceClient with default settings.

Throws:

IOException

create

public static final CatalogServiceClient create(CatalogServiceSettings settings)
                                         throws IOException

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.

Throws:

IOException

create

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

getSettings

public final CatalogServiceSettings getSettings()

getStub

public CatalogServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

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

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

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

createEntryTypeAsync

public final com.google.api.gax.longrunning.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:

parent - 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 - Required. EntryType Resource

entryTypeId - Required. EntryType identifier.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntryTypeAsync

public final com.google.api.gax.longrunning.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:

parent - 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 - Required. EntryType Resource

entryTypeId - Required. EntryType identifier.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntryTypeAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntryTypeOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

createEntryTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateEntryTypeRequest,com.google.longrunning.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();
 }
 

updateEntryTypeAsync

public final com.google.api.gax.longrunning.OperationFuture<EntryType,OperationMetadata> updateEntryTypeAsync(EntryType entryType,
                                                                                                              com.google.protobuf.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:

entryType - Required. EntryType Resource

updateMask - Required. Mask of fields to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntryTypeAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntryTypeOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

updateEntryTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateEntryTypeRequest,com.google.longrunning.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();
 }
 

deleteEntryTypeAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

name - Required. The resource name of the EntryType: `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntryTypeAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

name - Required. The resource name of the EntryType: `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntryTypeAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntryTypeOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteEntryTypeRequest,com.google.protobuf.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();
 }
 

deleteEntryTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteEntryTypeRequest,com.google.longrunning.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();
 }
 

listEntryTypes

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntryTypes

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntryTypes

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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntryTypesPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listEntryTypesCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

getEntryType

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);
 }
 

Parameters:

name - Required. The resource name of the EntryType: `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntryType

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);
 }
 

Parameters:

name - Required. The resource name of the EntryType: `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntryType

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntryTypeCallable

public final com.google.api.gax.rpc.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();
 }
 

createAspectTypeAsync

public final com.google.api.gax.longrunning.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:

parent - 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 - Required. AspectType Resource

aspectTypeId - Required. AspectType identifier.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAspectTypeAsync

public final com.google.api.gax.longrunning.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:

parent - 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 - Required. AspectType Resource

aspectTypeId - Required. AspectType identifier.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAspectTypeAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAspectTypeOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

createAspectTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateAspectTypeRequest,com.google.longrunning.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();
 }
 

updateAspectTypeAsync

public final com.google.api.gax.longrunning.OperationFuture<AspectType,OperationMetadata> updateAspectTypeAsync(AspectType aspectType,
                                                                                                                com.google.protobuf.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:

aspectType - Required. AspectType Resource

updateMask - Required. Mask of fields to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateAspectTypeAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateAspectTypeOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

updateAspectTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateAspectTypeRequest,com.google.longrunning.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();
 }
 

deleteAspectTypeAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

name - Required. The resource name of the AspectType: `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAspectTypeAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

name - Required. The resource name of the AspectType: `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAspectTypeAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAspectTypeOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteAspectTypeRequest,com.google.protobuf.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();
 }
 

deleteAspectTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteAspectTypeRequest,com.google.longrunning.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();
 }
 

listAspectTypes

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listAspectTypes

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listAspectTypes

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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listAspectTypesPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listAspectTypesCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

getAspectType

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);
 }
 

Parameters:

name - Required. The resource name of the AspectType: `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getAspectType

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);
 }
 

Parameters:

name - Required. The resource name of the AspectType: `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getAspectType

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getAspectTypeCallable

public final com.google.api.gax.rpc.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();
 }
 

createEntryGroupAsync

public final com.google.api.gax.longrunning.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:

parent - 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 - Required. EntryGroup Resource

entryGroupId - Required. EntryGroup identifier.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntryGroupAsync

public final com.google.api.gax.longrunning.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:

parent - 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 - Required. EntryGroup Resource

entryGroupId - Required. EntryGroup identifier.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntryGroupAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntryGroupOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

createEntryGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateEntryGroupRequest,com.google.longrunning.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();
 }
 

updateEntryGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<EntryGroup,OperationMetadata> updateEntryGroupAsync(EntryGroup entryGroup,
                                                                                                                com.google.protobuf.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:

entryGroup - Required. EntryGroup Resource

updateMask - Required. Mask of fields to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntryGroupAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntryGroupOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

updateEntryGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateEntryGroupRequest,com.google.longrunning.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();
 }
 

deleteEntryGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

name - Required. The resource name of the EntryGroup: `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntryGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

name - Required. The resource name of the EntryGroup: `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntryGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntryGroupOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteEntryGroupRequest,com.google.protobuf.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();
 }
 

deleteEntryGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteEntryGroupRequest,com.google.longrunning.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();
 }
 

listEntryGroups

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntryGroups

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntryGroups

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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntryGroupsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listEntryGroupsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

getEntryGroup

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);
 }
 

Parameters:

name - Required. The resource name of the EntryGroup: `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntryGroup

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);
 }
 

Parameters:

name - Required. The resource name of the EntryGroup: `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntryGroup

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntryGroupCallable

public final com.google.api.gax.rpc.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();
 }
 

createEntry

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:

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

entry - Required. Entry resource.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntry

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:

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

entry - Required. Entry resource.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntry

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntryCallable

public final com.google.api.gax.rpc.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();
 }
 

updateEntry

public final Entry updateEntry(Entry entry,
                               com.google.protobuf.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:

entry - Required. Entry resource.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntry

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntryCallable

public final com.google.api.gax.rpc.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();
 }
 

deleteEntry

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntry

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntry

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntryCallable

public final com.google.api.gax.rpc.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();
 }
 

listEntries

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntries

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntries

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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntriesPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listEntriesCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

getEntry

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntry

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntry

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntryCallable

public final com.google.api.gax.rpc.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();
 }
 

lookupEntry

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

lookupEntryCallable

public final com.google.api.gax.rpc.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();
 }
 

searchEntries

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 - Required. The project to which the request should be attributed in the following form: `projects/{project}/locations/{location}`.

query - Required. The query against which entries in scope should be matched.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchEntries

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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchEntriesPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

searchEntriesCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

listLocations

public final CatalogServiceClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.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);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listLocationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.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);
   }
 }
 

listLocationsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.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;
     }
   }
 }
 

getLocation

public final com.google.cloud.location.Location getLocation(com.google.cloud.location.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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getLocationCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException