Class ContentServiceClient
- java.lang.Object
-
- com.google.cloud.dataplex.v1.ContentServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class ContentServiceClient extends Object implements com.google.api.gax.core.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:
// 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 (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:
- 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.
- 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.
- 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:
// 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 ContentServiceSettings contentServiceSettings = ContentServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); ContentServiceClient contentServiceClient = ContentServiceClient.create(contentServiceSettings);
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 ContentServiceSettings contentServiceSettings = ContentServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); ContentServiceClient contentServiceClient = ContentServiceClient.create(contentServiceSettings);
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 ContentServiceSettings contentServiceSettings = ContentServiceSettings.newHttpJsonBuilder().build(); ContentServiceClient contentServiceClient = ContentServiceClient.create(contentServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ContentServiceClient.ListContentFixedSizeCollection
static class
ContentServiceClient.ListContentPage
static class
ContentServiceClient.ListContentPagedResponse
static class
ContentServiceClient.ListLocationsFixedSizeCollection
static class
ContentServiceClient.ListLocationsPage
static class
ContentServiceClient.ListLocationsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
ContentServiceClient(ContentServiceSettings settings)
Constructs an instance of ContentServiceClient, using the given settings.protected
ContentServiceClient(ContentServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static ContentServiceClient
create()
Constructs an instance of ContentServiceClient with default settings.static ContentServiceClient
create(ContentServiceSettings settings)
Constructs an instance of ContentServiceClient, using the given settings.static ContentServiceClient
create(ContentServiceStub stub)
Constructs an instance of ContentServiceClient, using the given stub for making calls.Content
createContent(CreateContentRequest request)
Create a content.Content
createContent(LakeName parent, Content content)
Create a content.Content
createContent(String parent, Content content)
Create a content.com.google.api.gax.rpc.UnaryCallable<CreateContentRequest,Content>
createContentCallable()
Create a content.void
deleteContent(ContentName name)
Delete a content.void
deleteContent(DeleteContentRequest request)
Delete a content.void
deleteContent(String name)
Delete a content.com.google.api.gax.rpc.UnaryCallable<DeleteContentRequest,com.google.protobuf.Empty>
deleteContentCallable()
Delete a content.Content
getContent(ContentName name)
Get a content resource.Content
getContent(GetContentRequest request)
Get a content resource.Content
getContent(String name)
Get a content resource.com.google.api.gax.rpc.UnaryCallable<GetContentRequest,Content>
getContentCallable()
Get a content resource.com.google.iam.v1.Policy
getIamPolicy(com.google.api.resourcenames.ResourceName resource)
Gets the access control policy for a contentitem resource.com.google.iam.v1.Policy
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a contentitem resource.com.google.iam.v1.Policy
getIamPolicy(String resource)
Gets the access control policy for a contentitem resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicyCallable()
Gets the access control policy for a contentitem resource.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.ContentServiceSettings
getSettings()
ContentServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
ContentServiceClient.ListContentPagedResponse
listContent(LakeName parent)
List content.ContentServiceClient.ListContentPagedResponse
listContent(ListContentRequest request)
List content.ContentServiceClient.ListContentPagedResponse
listContent(String parent)
List content.com.google.api.gax.rpc.UnaryCallable<ListContentRequest,ListContentResponse>
listContentCallable()
List content.com.google.api.gax.rpc.UnaryCallable<ListContentRequest,ContentServiceClient.ListContentPagedResponse>
listContentPagedCallable()
List content.ContentServiceClient.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,ContentServiceClient.ListLocationsPagedResponse>
listLocationsPagedCallable()
Lists information about the supported locations for this service.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified contentitem resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicyCallable()
Sets the access control policy on the specified contentitem resource.void
shutdown()
void
shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns the caller's permissions on a resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsCallable()
Returns the caller's permissions on a resource.Content
updateContent(Content content, com.google.protobuf.FieldMask updateMask)
Update a content.Content
updateContent(UpdateContentRequest request)
Update a content.com.google.api.gax.rpc.UnaryCallable<UpdateContentRequest,Content>
updateContentCallable()
Update a content.
-
-
-
Constructor Detail
-
ContentServiceClient
protected ContentServiceClient(ContentServiceSettings settings) throws IOException
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.- Throws:
IOException
-
ContentServiceClient
protected ContentServiceClient(ContentServiceStub stub)
-
-
Method Detail
-
create
public static final ContentServiceClient create() throws IOException
Constructs an instance of ContentServiceClient with default settings.- Throws:
IOException
-
create
public static final ContentServiceClient create(ContentServiceSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final ContentServiceSettings getSettings()
-
getStub
public ContentServiceStub getStub()
-
createContent
public final Content createContent(LakeName parent, Content content)
Create a content.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]"); Content content = Content.newBuilder().build(); Content response = contentServiceClient.createContent(parent, content); }
- Parameters:
parent
- Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}content
- Required. Content resource.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createContent
public final Content createContent(String parent, Content content)
Create a content.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString(); Content content = Content.newBuilder().build(); Content response = contentServiceClient.createContent(parent, content); }
- Parameters:
parent
- Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}content
- Required. Content resource.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createContent
public final Content createContent(CreateContentRequest request)
Create a content.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 (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); }
- 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
-
createContentCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateContentRequest,Content> createContentCallable()
Create a content.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 (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(); }
-
updateContent
public final Content updateContent(Content content, com.google.protobuf.FieldMask updateMask)
Update a content. Only supports full resource update.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { Content content = Content.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Content response = contentServiceClient.updateContent(content, updateMask); }
- Parameters:
content
- Required. Update description. Only fields specified in `update_mask` are updated.updateMask
- Required. Mask of fields to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateContent
public final Content updateContent(UpdateContentRequest request)
Update a content. Only supports full resource update.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { UpdateContentRequest request = UpdateContentRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setContent(Content.newBuilder().build()) .setValidateOnly(true) .build(); Content response = contentServiceClient.updateContent(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
-
updateContentCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateContentRequest,Content> updateContentCallable()
Update a content. Only supports full resource update.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 (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(); }
-
deleteContent
public final void deleteContent(ContentName name)
Delete a content.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { ContentName name = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]"); contentServiceClient.deleteContent(name); }
- Parameters:
name
- Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteContent
public final void deleteContent(String name)
Delete a content.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { String name = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString(); contentServiceClient.deleteContent(name); }
- Parameters:
name
- Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteContent
public final void deleteContent(DeleteContentRequest request)
Delete a content.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { DeleteContentRequest request = DeleteContentRequest.newBuilder() .setName(ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString()) .build(); contentServiceClient.deleteContent(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
-
deleteContentCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteContentRequest,com.google.protobuf.Empty> deleteContentCallable()
Delete a content.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 (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(); }
-
getContent
public final Content getContent(ContentName name)
Get a content 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { ContentName name = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]"); Content response = contentServiceClient.getContent(name); }
- Parameters:
name
- Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getContent
public final Content getContent(String name)
Get a content 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { String name = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString(); Content response = contentServiceClient.getContent(name); }
- Parameters:
name
- Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getContent
public final Content getContent(GetContentRequest request)
Get a content 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { GetContentRequest request = GetContentRequest.newBuilder() .setName(ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString()) .build(); Content response = contentServiceClient.getContent(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
-
getContentCallable
public final com.google.api.gax.rpc.UnaryCallable<GetContentRequest,Content> getContentCallable()
Get a content 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 (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(); }
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.api.resourcenames.ResourceName resource)
Gets the access control policy for a contentitem resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM `dataplex.content.getIamPolicy` permission on the 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { ResourceName resource = ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]"); Policy response = contentServiceClient.getIamPolicy(resource); }
- Parameters:
resource
- REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(String resource)
Gets the access control policy for a contentitem resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM `dataplex.content.getIamPolicy` permission on the 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { String resource = AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString(); Policy response = contentServiceClient.getIamPolicy(resource); }
- Parameters:
resource
- REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a contentitem resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM `dataplex.content.getIamPolicy` permission on the 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource( ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); Policy response = contentServiceClient.getIamPolicy(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
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()
Gets the access control policy for a contentitem resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM `dataplex.content.getIamPolicy` permission on the 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource( ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); ApiFuture<Policy> future = contentServiceClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM `dataplex.content.setIamPolicy` permission on the 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource( ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Policy response = contentServiceClient.setIamPolicy(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
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM `dataplex.content.setIamPolicy` permission on the 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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource( ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Policy> future = contentServiceClient.setIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a `NOT_FOUND` error is not returned).A caller is not required to have Google IAM permission to make this request.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource( ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); TestIamPermissionsResponse response = contentServiceClient.testIamPermissions(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
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a `NOT_FOUND` error is not returned).A caller is not required to have Google IAM permission to make this request.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource( ContentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[CONTENT]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); ApiFuture<TestIamPermissionsResponse> future = contentServiceClient.testIamPermissionsCallable().futureCall(request); // Do something. TestIamPermissionsResponse response = future.get(); }
-
listContent
public final ContentServiceClient.ListContentPagedResponse listContent(LakeName parent)
List content.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]"); for (Content element : contentServiceClient.listContent(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listContent
public final ContentServiceClient.ListContentPagedResponse listContent(String parent)
List content.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString(); for (Content element : contentServiceClient.listContent(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listContent
public final ContentServiceClient.ListContentPagedResponse listContent(ListContentRequest request)
List content.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 (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); } }
- 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
-
listContentPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListContentRequest,ContentServiceClient.ListContentPagedResponse> listContentPagedCallable()
List content.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 (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); } }
-
listContentCallable
public final com.google.api.gax.rpc.UnaryCallable<ListContentRequest,ListContentResponse> listContentCallable()
List content.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 (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.getContentList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listLocations
public final ContentServiceClient.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : contentServiceClient.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,ContentServiceClient.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = contentServiceClient.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = contentServiceClient.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); Location response = contentServiceClient.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 (ContentServiceClient contentServiceClient = ContentServiceClient.create()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); ApiFuture<Location> future = contentServiceClient.getLocationCallable().futureCall(request); // Do something. Location response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-