- 1.46.0 (latest)
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.2
- 1.0.1
- 0.2.2
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
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().
Method | Description | Method Variants |
---|---|---|
CreateContent | Create a content. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateContent | Update a content. Only supports full resource update. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteContent | Delete a content. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetContent | Get a content resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy | Gets the access control policy for a contentitem resource. A Caller must have Google IAM |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy | Sets the access control policy on the specified contentitem resource. Replaces any existing policy. Caller must have Google IAM |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions | Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a 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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListContent | List content. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation | Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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.
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:
// 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);
}
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:
// 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 | |
---|---|
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:
// 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 | |
---|---|
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:
// 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateContentRequest,Content> |
deleteContent(ContentName name)
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);
}
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:
// 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);
}
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:
// 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);
}
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:
// 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteContentRequest,Empty> |
getContent(ContentName name)
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);
}
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:
// 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);
}
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:
// 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);
}
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:
// 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetContentRequest,Content> |
getIamPolicy(ResourceName resource)
public final Policy getIamPolicy(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);
}
Parameter | |
---|---|
Name | Description |
resource | com.google.api.resourcenames.ResourceName REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(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);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
getIamPolicy(String resource)
public final 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);
}
Parameter | |
---|---|
Name | Description |
resource | String REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = contentServiceClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = contentServiceClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
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:
// 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);
}
}
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:
// 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);
}
}
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:
// 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);
}
}
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:
// 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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListContentRequest,ListContentResponse> |
listContentPagedCallable()
public final 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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListContentRequest,ListContentPagedResponse> |
listLocations(ListLocationsRequest request)
public final ContentServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ContentServiceClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(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);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(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);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
updateContent(Content content, FieldMask updateMask)
public final Content updateContent(Content content, 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 | |
---|---|
Name | Description |
content | Content Required. Update description. Only fields specified in |
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:
// 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);
}
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:
// 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateContentRequest,Content> |