Class ContentServiceClient (0.2.2) 

public class ContentServiceClient implements BackgroundResource

Service Description: ContentService manages Notebook and SQL Scripts for Dataplex.

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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   Content content = Content.newBuilder().build();
   Content response = contentServiceClient.createContent(parent, content);
 }

Note: close() needs to be called on the ContentServiceClient 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 ContentServiceSettings to create(). For example:

To customize credentials:


 ContentServiceSettings contentServiceSettings =
     ContentServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContentServiceClient contentServiceClient = ContentServiceClient.create(contentServiceSettings);

To customize the endpoint:


 ContentServiceSettings contentServiceSettings =
     ContentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContentServiceClient contentServiceClient = ContentServiceClient.create(contentServiceSettings);

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

Inheritance

java.lang.Object > ContentServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final ContentServiceClient create()

Constructs an instance of ContentServiceClient with default settings.

Returns
Type Description
ContentServiceClient
Exceptions
Type Description
IOException

create(ContentServiceSettings settings)

public static final ContentServiceClient create(ContentServiceSettings settings)

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

Parameter
Name Description
settings ContentServiceSettings
Returns
Type Description
ContentServiceClient
Exceptions
Type Description
IOException

create(ContentServiceStub stub)

public static final ContentServiceClient create(ContentServiceStub stub)

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

Parameter
Name Description
stub ContentServiceStub
Returns
Type Description
ContentServiceClient

Constructors

ContentServiceClient(ContentServiceSettings settings)

protected ContentServiceClient(ContentServiceSettings settings)

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

Parameter
Name Description
settings ContentServiceSettings

ContentServiceClient(ContentServiceStub stub)

protected ContentServiceClient(ContentServiceStub stub)
Parameter
Name Description
stub ContentServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

createContent(CreateContentRequest request)

public final Content createContent(CreateContentRequest request)

Create a content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   CreateContentRequest request =
       CreateContentRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setContent(Content.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Content response = contentServiceClient.createContent(request);
 }
Parameter
Name Description
request CreateContentRequest

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

createContent(LakeName parent, Content content)

public final Content createContent(LakeName parent, Content content)

Create a content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   Content content = Content.newBuilder().build();
   Content response = contentServiceClient.createContent(parent, content);
 }
Parameters
Name Description
parent LakeName

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
content Content

Required. Content resource.
Returns
Type Description
Content

createContent(String parent, Content content)

public final Content createContent(String parent, Content content)

Create a content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   Content content = Content.newBuilder().build();
   Content response = contentServiceClient.createContent(parent, content);
 }
Parameters
Name Description
parent String

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
content Content

Required. Content resource.
Returns
Type Description
Content

createContentCallable()

public final UnaryCallable<CreateContentRequest,Content> createContentCallable()

Create a content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   CreateContentRequest request =
       CreateContentRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setContent(Content.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Content> future = contentServiceClient.createContentCallable().futureCall(request);
   // Do something.
   Content response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateContentRequest,Content>

deleteContent(ContentName name)

public final void deleteContent(ContentName name)

Delete a content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   ContentName name = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]");
   contentServiceClient.deleteContent(name);
 }
Parameter
Name Description
name ContentName

Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

deleteContent(DeleteContentRequest request)

public final void deleteContent(DeleteContentRequest request)

Delete a content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   DeleteContentRequest request =
       DeleteContentRequest.newBuilder()
           .setName(ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString())
           .build();
   contentServiceClient.deleteContent(request);
 }
Parameter
Name Description
request DeleteContentRequest

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

deleteContent(String name)

public final void deleteContent(String name)

Delete a content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   String name = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString();
   contentServiceClient.deleteContent(name);
 }
Parameter
Name Description
name String

Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

deleteContentCallable()

public final UnaryCallable<DeleteContentRequest,Empty> deleteContentCallable()

Delete a content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   DeleteContentRequest request =
       DeleteContentRequest.newBuilder()
           .setName(ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString())
           .build();
   ApiFuture<Empty> future = contentServiceClient.deleteContentCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteContentRequest,Empty>

getContent(ContentName name)

public final Content getContent(ContentName name)

Get a content resource.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   ContentName name = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]");
   Content response = contentServiceClient.getContent(name);
 }
Parameter
Name Description
name ContentName

Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
Returns
Type Description
Content

getContent(GetContentRequest request)

public final Content getContent(GetContentRequest request)

Get a content resource.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   GetContentRequest request =
       GetContentRequest.newBuilder()
           .setName(ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString())
           .build();
   Content response = contentServiceClient.getContent(request);
 }
Parameter
Name Description
request GetContentRequest

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

getContent(String name)

public final Content getContent(String name)

Get a content resource.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   String name = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString();
   Content response = contentServiceClient.getContent(name);
 }
Parameter
Name Description
name String

Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}
Returns
Type Description
Content

getContentCallable()

public final UnaryCallable<GetContentRequest,Content> getContentCallable()

Get a content resource.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   GetContentRequest request =
       GetContentRequest.newBuilder()
           .setName(ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString())
           .build();
   ApiFuture<Content> future = contentServiceClient.getContentCallable().futureCall(request);
   // Do something.
   Content response = future.get();
 }
Returns
Type Description
UnaryCallable<GetContentRequest,Content>

getSettings()

public final ContentServiceSettings getSettings()
Returns
Type Description
ContentServiceSettings

getStub()

public ContentServiceStub getStub()
Returns
Type Description
ContentServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listContent(LakeName parent)

public final ContentServiceClient.ListContentPagedResponse listContent(LakeName parent)

List content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   for (Content element : contentServiceClient.listContent(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LakeName

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
Returns
Type Description
ContentServiceClient.ListContentPagedResponse

listContent(ListContentRequest request)

public final ContentServiceClient.ListContentPagedResponse listContent(ListContentRequest request)

List content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   ListContentRequest request =
       ListContentRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Content element : contentServiceClient.listContent(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListContentRequest

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

listContent(String parent)

public final ContentServiceClient.ListContentPagedResponse listContent(String parent)

List content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   for (Content element : contentServiceClient.listContent(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
Returns
Type Description
ContentServiceClient.ListContentPagedResponse

listContentCallable()

public final UnaryCallable<ListContentRequest,ListContentResponse> listContentCallable()

List content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   ListContentRequest request =
       ListContentRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListContentResponse response = contentServiceClient.listContentCallable().call(request);
     for (Content element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListContentRequest,ListContentResponse>

listContentPagedCallable()

public final UnaryCallable<ListContentRequest,ContentServiceClient.ListContentPagedResponse> listContentPagedCallable()

List content.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   ListContentRequest request =
       ListContentRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Content> future =
       contentServiceClient.listContentPagedCallable().futureCall(request);
   // Do something.
   for (Content element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListContentRequest,ListContentPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateContent(Content content, FieldMask updateMask)

public final Content updateContent(Content content, FieldMask updateMask)

Update a content. Only supports full resource update.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   Content content = Content.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Content response = contentServiceClient.updateContent(content, updateMask);
 }
Parameters
Name Description
content Content

Required. Update description. Only fields specified in update_mask are updated.
updateMask FieldMask

Required. Mask of fields to update.
Returns
Type Description
Content

updateContent(UpdateContentRequest request)

public final Content updateContent(UpdateContentRequest request)

Update a content. Only supports full resource update.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   UpdateContentRequest request =
       UpdateContentRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setContent(Content.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Content response = contentServiceClient.updateContent(request);
 }
Parameter
Name Description
request UpdateContentRequest

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

updateContentCallable()

public final UnaryCallable<UpdateContentRequest,Content> updateContentCallable()

Update a content. Only supports full resource update.

Sample code:


 try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
   UpdateContentRequest request =
       UpdateContentRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setContent(Content.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Content> future = contentServiceClient.updateContentCallable().futureCall(request);
   // Do something.
   Content response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateContentRequest,Content>