com.google.cloud.datacatalog.v1beta1

Class DataCatalogClient

java.lang.Object

com.google.cloud.datacatalog.v1beta1.DataCatalogClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class DataCatalogClient
extends Object
implements BackgroundResource

Service Description: Cloud Data Catalog is a service that allows clients to discover, manage, and understand their Google Cloud data resources.

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:

 
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   LookupEntryRequest request = LookupEntryRequest.newBuilder().build();
   Entry response = dataCatalogClient.lookupEntry(request);
 }
 
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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 DataCatalogSettings to create(). For example:

To customize credentials:

 
 DataCatalogSettings dataCatalogSettings =
     DataCatalogSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataCatalogClient dataCatalogClient =
     DataCatalogClient.create(dataCatalogSettings);
 
 

To customize the endpoint:

 
 DataCatalogSettings dataCatalogSettings =
     DataCatalogSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataCatalogClient dataCatalogClient =
     DataCatalogClient.create(dataCatalogSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataCatalogClient(DataCatalogSettings settings) Constructs an instance of DataCatalogClient, using the given settings.
protected	DataCatalogClient(DataCatalogStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static DataCatalogClient	create() Constructs an instance of DataCatalogClient with default settings.
static DataCatalogClient	create(DataCatalogSettings settings) Constructs an instance of DataCatalogClient, using the given settings.
static DataCatalogClient	create(DataCatalogStub stub) Constructs an instance of DataCatalogClient, using the given stub for making calls.
static String	formatEntryName(String project, String location, String entryGroup, String entry) Deprecated. Use the EntryName class instead.
static String	formatLocationName(String project, String location) Deprecated. Use the LocationName class instead.
DataCatalogSettings	getSettings()
DataCatalogStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
com.google.cloud.datacatalog.Entry	lookupEntry(com.google.cloud.datacatalog.LookupEntryRequest request) Get an entry by target resource name.
UnaryCallable<com.google.cloud.datacatalog.LookupEntryRequest,com.google.cloud.datacatalog.Entry>	lookupEntryCallable() Get an entry by target resource name.
static String	parseEntryFromEntryName(String entryName) Deprecated. Use the EntryName class instead.
static String	parseEntryGroupFromEntryName(String entryName) Deprecated. Use the EntryName class instead.
static String	parseLocationFromEntryName(String entryName) Deprecated. Use the EntryName class instead.
static String	parseLocationFromLocationName(String locationName) Deprecated. Use the LocationName class instead.
static String	parseProjectFromEntryName(String entryName) Deprecated. Use the EntryName class instead.
static String	parseProjectFromLocationName(String locationName) Deprecated. Use the LocationName class instead.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataCatalogClient

protected DataCatalogClient(DataCatalogSettings settings)
                     throws IOException

Constructs an instance of DataCatalogClient, 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

DataCatalogClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected DataCatalogClient(DataCatalogStub stub)

Method Detail

formatEntryName

@Deprecated
public static final String formatEntryName(String project,
                                                       String location,
                                                       String entryGroup,
                                                       String entry)

Deprecated. Use the EntryName class instead.

Formats a string containing the fully-qualified path to represent a entry resource.

formatLocationName

@Deprecated
public static final String formatLocationName(String project,
                                                          String location)

Deprecated. Use the LocationName class instead.

Formats a string containing the fully-qualified path to represent a location resource.

parseProjectFromEntryName

@Deprecated
public static final String parseProjectFromEntryName(String entryName)

Deprecated. Use the EntryName class instead.

Parses the project from the given fully-qualified path which represents a entry resource.

parseLocationFromEntryName

@Deprecated
public static final String parseLocationFromEntryName(String entryName)

Deprecated. Use the EntryName class instead.

Parses the location from the given fully-qualified path which represents a entry resource.

parseEntryGroupFromEntryName

@Deprecated
public static final String parseEntryGroupFromEntryName(String entryName)

Deprecated. Use the EntryName class instead.

Parses the entry_group from the given fully-qualified path which represents a entry resource.

parseEntryFromEntryName

@Deprecated
public static final String parseEntryFromEntryName(String entryName)

Deprecated. Use the EntryName class instead.

Parses the entry from the given fully-qualified path which represents a entry resource.

parseProjectFromLocationName

@Deprecated
public static final String parseProjectFromLocationName(String locationName)

Deprecated. Use the LocationName class instead.

Parses the project from the given fully-qualified path which represents a location resource.

parseLocationFromLocationName

@Deprecated
public static final String parseLocationFromLocationName(String locationName)

Deprecated. Use the LocationName class instead.

Parses the location from the given fully-qualified path which represents a location resource.

create

public static final DataCatalogClient create()
                                      throws IOException

Constructs an instance of DataCatalogClient with default settings.

Throws:

IOException

create

public static final DataCatalogClient create(DataCatalogSettings settings)
                                      throws IOException

Constructs an instance of DataCatalogClient, 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final DataCatalogClient create(DataCatalogStub stub)

Constructs an instance of DataCatalogClient, using the given stub for making calls. This is for advanced usage - prefer to use DataCatalogSettings}.

getSettings

public final DataCatalogSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public DataCatalogStub getStub()

lookupEntry

public final com.google.cloud.datacatalog.Entry lookupEntry(com.google.cloud.datacatalog.LookupEntryRequest request)

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Cloud Data Catalog Entry.

Sample code:

 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   LookupEntryRequest request = LookupEntryRequest.newBuilder().build();
   Entry response = dataCatalogClient.lookupEntry(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

lookupEntryCallable

public final UnaryCallable<com.google.cloud.datacatalog.LookupEntryRequest,com.google.cloud.datacatalog.Entry> lookupEntryCallable()

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Cloud Data Catalog Entry.

Sample code:

 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   LookupEntryRequest request = LookupEntryRequest.newBuilder().build();
   ApiFuture<Entry> future = dataCatalogClient.lookupEntryCallable().futureCall(request);
   // Do something
   Entry response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException