- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 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.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.24.0
- 1.23.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.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class ServiceAttachmentsClient implements BackgroundResource
Service Description: The ServiceAttachments API.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String serviceAttachment = "serviceAttachment-398467656";
ServiceAttachment response = serviceAttachmentsClient.get(project, region, serviceAttachment);
}
Note: close() needs to be called on the ServiceAttachmentsClient 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 ServiceAttachmentsSettings 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
ServiceAttachmentsSettings serviceAttachmentsSettings =
ServiceAttachmentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ServiceAttachmentsClient serviceAttachmentsClient =
ServiceAttachmentsClient.create(serviceAttachmentsSettings);
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
ServiceAttachmentsSettings serviceAttachmentsSettings =
ServiceAttachmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
ServiceAttachmentsClient serviceAttachmentsClient =
ServiceAttachmentsClient.create(serviceAttachmentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final ServiceAttachmentsClient create()
Constructs an instance of ServiceAttachmentsClient with default settings.
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ServiceAttachmentsSettings settings)
public static final ServiceAttachmentsClient create(ServiceAttachmentsSettings settings)
Constructs an instance of ServiceAttachmentsClient, 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 | ServiceAttachmentsSettings |
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ServiceAttachmentsStub stub)
public static final ServiceAttachmentsClient create(ServiceAttachmentsStub stub)
Constructs an instance of ServiceAttachmentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ServiceAttachmentsSettings).
Parameter | |
---|---|
Name | Description |
stub | ServiceAttachmentsStub |
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient |
Constructors
ServiceAttachmentsClient(ServiceAttachmentsSettings settings)
protected ServiceAttachmentsClient(ServiceAttachmentsSettings settings)
Constructs an instance of ServiceAttachmentsClient, 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 | ServiceAttachmentsSettings |
ServiceAttachmentsClient(ServiceAttachmentsStub stub)
protected ServiceAttachmentsClient(ServiceAttachmentsStub stub)
Parameter | |
---|---|
Name | Description |
stub | ServiceAttachmentsStub |
Methods
aggregatedList(AggregatedListServiceAttachmentsRequest request)
public final ServiceAttachmentsClient.AggregatedListPagedResponse aggregatedList(AggregatedListServiceAttachmentsRequest request)
Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
AggregatedListServiceAttachmentsRequest request =
AggregatedListServiceAttachmentsRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
for (Map.Entry<String, ServiceAttachmentsScopedList> element :
serviceAttachmentsClient.aggregatedList(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | AggregatedListServiceAttachmentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient.AggregatedListPagedResponse |
aggregatedList(String project)
public final ServiceAttachmentsClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
for (Map.Entry<String, ServiceAttachmentsScopedList> element :
serviceAttachmentsClient.aggregatedList(project).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
project | String Name of the project scoping this request. |
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient.AggregatedListPagedResponse |
aggregatedListCallable()
public final UnaryCallable<AggregatedListServiceAttachmentsRequest,ServiceAttachmentAggregatedList> aggregatedListCallable()
Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
AggregatedListServiceAttachmentsRequest request =
AggregatedListServiceAttachmentsRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
while (true) {
ServiceAttachmentAggregatedList response =
serviceAttachmentsClient.aggregatedListCallable().call(request);
for (Map.Entry<String, ServiceAttachmentsScopedList> element : response.getItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AggregatedListServiceAttachmentsRequest,ServiceAttachmentAggregatedList> |
aggregatedListPagedCallable()
public final UnaryCallable<AggregatedListServiceAttachmentsRequest,ServiceAttachmentsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
AggregatedListServiceAttachmentsRequest request =
AggregatedListServiceAttachmentsRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
ApiFuture<Map.Entry<String, ServiceAttachmentsScopedList>> future =
serviceAttachmentsClient.aggregatedListPagedCallable().futureCall(request);
// Do something.
for (Map.Entry<String, ServiceAttachmentsScopedList> element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AggregatedListServiceAttachmentsRequest,AggregatedListPagedResponse> |
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()
deleteAsync(DeleteServiceAttachmentRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteServiceAttachmentRequest request)
Deletes the specified ServiceAttachment in the given scope
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
DeleteServiceAttachmentRequest request =
DeleteServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachment("serviceAttachment-398467656")
.build();
Operation response = serviceAttachmentsClient.deleteAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteServiceAttachmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String region, String serviceAttachment)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String serviceAttachment)
Deletes the specified ServiceAttachment in the given scope
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String serviceAttachment = "serviceAttachment-398467656";
Operation response =
serviceAttachmentsClient.deleteAsync(project, region, serviceAttachment).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region of this request. |
serviceAttachment | String Name of the ServiceAttachment resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteServiceAttachmentRequest,Operation> deleteCallable()
Deletes the specified ServiceAttachment in the given scope
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
DeleteServiceAttachmentRequest request =
DeleteServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachment("serviceAttachment-398467656")
.build();
ApiFuture<Operation> future = serviceAttachmentsClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteServiceAttachmentRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteServiceAttachmentRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified ServiceAttachment in the given scope
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
DeleteServiceAttachmentRequest request =
DeleteServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachment("serviceAttachment-398467656")
.build();
OperationFuture<Operation, Operation> future =
serviceAttachmentsClient.deleteOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteServiceAttachmentRequest,Operation,Operation> |
get(GetServiceAttachmentRequest request)
public final ServiceAttachment get(GetServiceAttachmentRequest request)
Returns the specified ServiceAttachment resource in the given scope.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
GetServiceAttachmentRequest request =
GetServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setServiceAttachment("serviceAttachment-398467656")
.build();
ServiceAttachment response = serviceAttachmentsClient.get(request);
}
Parameter | |
---|---|
Name | Description |
request | GetServiceAttachmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ServiceAttachment |
get(String project, String region, String serviceAttachment)
public final ServiceAttachment get(String project, String region, String serviceAttachment)
Returns the specified ServiceAttachment resource in the given scope.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String serviceAttachment = "serviceAttachment-398467656";
ServiceAttachment response = serviceAttachmentsClient.get(project, region, serviceAttachment);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region of this request. |
serviceAttachment | String Name of the ServiceAttachment resource to return. |
Returns | |
---|---|
Type | Description |
ServiceAttachment |
getCallable()
public final UnaryCallable<GetServiceAttachmentRequest,ServiceAttachment> getCallable()
Returns the specified ServiceAttachment resource in the given scope.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
GetServiceAttachmentRequest request =
GetServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setServiceAttachment("serviceAttachment-398467656")
.build();
ApiFuture<ServiceAttachment> future =
serviceAttachmentsClient.getCallable().futureCall(request);
// Do something.
ServiceAttachment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetServiceAttachmentRequest,ServiceAttachment> |
getIamPolicy(GetIamPolicyServiceAttachmentRequest request)
public final Policy getIamPolicy(GetIamPolicyServiceAttachmentRequest request)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
GetIamPolicyServiceAttachmentRequest request =
GetIamPolicyServiceAttachmentRequest.newBuilder()
.setOptionsRequestedPolicyVersion(-574521795)
.setProject("project-309310695")
.setRegion("region-934795532")
.setResource("resource-341064690")
.build();
Policy response = serviceAttachmentsClient.getIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | GetIamPolicyServiceAttachmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Policy |
getIamPolicy(String project, String region, String resource)
public final Policy getIamPolicy(String project, String region, String resource)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String resource = "resource-341064690";
Policy response = serviceAttachmentsClient.getIamPolicy(project, region, resource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
resource | String Name or id of the resource for this request. |
Returns | |
---|---|
Type | Description |
Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyServiceAttachmentRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
GetIamPolicyServiceAttachmentRequest request =
GetIamPolicyServiceAttachmentRequest.newBuilder()
.setOptionsRequestedPolicyVersion(-574521795)
.setProject("project-309310695")
.setRegion("region-934795532")
.setResource("resource-341064690")
.build();
ApiFuture<Policy> future =
serviceAttachmentsClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetIamPolicyServiceAttachmentRequest,Policy> |
getSettings()
public final ServiceAttachmentsSettings getSettings()
Returns | |
---|---|
Type | Description |
ServiceAttachmentsSettings |
getStub()
public ServiceAttachmentsStub getStub()
Returns | |
---|---|
Type | Description |
ServiceAttachmentsStub |
insertAsync(InsertServiceAttachmentRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertServiceAttachmentRequest request)
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
InsertServiceAttachmentRequest request =
InsertServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachmentResource(ServiceAttachment.newBuilder().build())
.build();
Operation response = serviceAttachmentsClient.insertAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | InsertServiceAttachmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, String region, ServiceAttachment serviceAttachmentResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, String region, ServiceAttachment serviceAttachmentResource)
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
ServiceAttachment serviceAttachmentResource = ServiceAttachment.newBuilder().build();
Operation response =
serviceAttachmentsClient.insertAsync(project, region, serviceAttachmentResource).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region of this request. |
serviceAttachmentResource | ServiceAttachment The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertServiceAttachmentRequest,Operation> insertCallable()
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
InsertServiceAttachmentRequest request =
InsertServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachmentResource(ServiceAttachment.newBuilder().build())
.build();
ApiFuture<Operation> future = serviceAttachmentsClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<InsertServiceAttachmentRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertServiceAttachmentRequest,Operation,Operation> insertOperationCallable()
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
InsertServiceAttachmentRequest request =
InsertServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachmentResource(ServiceAttachment.newBuilder().build())
.build();
OperationFuture<Operation, Operation> future =
serviceAttachmentsClient.insertOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<InsertServiceAttachmentRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
list(ListServiceAttachmentsRequest request)
public final ServiceAttachmentsClient.ListPagedResponse list(ListServiceAttachmentsRequest request)
Lists the ServiceAttachments for a project in the given scope.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
ListServiceAttachmentsRequest request =
ListServiceAttachmentsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
for (ServiceAttachment element : serviceAttachmentsClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListServiceAttachmentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient.ListPagedResponse |
list(String project, String region)
public final ServiceAttachmentsClient.ListPagedResponse list(String project, String region)
Lists the ServiceAttachments for a project in the given scope.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
for (ServiceAttachment element :
serviceAttachmentsClient.list(project, region).iterateAll()) {
// doThingsWith(element);
}
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region of this request. |
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListServiceAttachmentsRequest,ServiceAttachmentList> listCallable()
Lists the ServiceAttachments for a project in the given scope.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
ListServiceAttachmentsRequest request =
ListServiceAttachmentsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
while (true) {
ServiceAttachmentList response = serviceAttachmentsClient.listCallable().call(request);
for (ServiceAttachment element : response.getItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListServiceAttachmentsRequest,ServiceAttachmentList> |
listPagedCallable()
public final UnaryCallable<ListServiceAttachmentsRequest,ServiceAttachmentsClient.ListPagedResponse> listPagedCallable()
Lists the ServiceAttachments for a project in the given scope.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
ListServiceAttachmentsRequest request =
ListServiceAttachmentsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
ApiFuture<ServiceAttachment> future =
serviceAttachmentsClient.listPagedCallable().futureCall(request);
// Do something.
for (ServiceAttachment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListServiceAttachmentsRequest,ListPagedResponse> |
patchAsync(PatchServiceAttachmentRequest request)
public final OperationFuture<Operation,Operation> patchAsync(PatchServiceAttachmentRequest request)
Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
PatchServiceAttachmentRequest request =
PatchServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachment("serviceAttachment-398467656")
.setServiceAttachmentResource(ServiceAttachment.newBuilder().build())
.build();
Operation response = serviceAttachmentsClient.patchAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | PatchServiceAttachmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
patchAsync(String project, String region, String serviceAttachment, ServiceAttachment serviceAttachmentResource)
public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String serviceAttachment, ServiceAttachment serviceAttachmentResource)
Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String serviceAttachment = "serviceAttachment-398467656";
ServiceAttachment serviceAttachmentResource = ServiceAttachment.newBuilder().build();
Operation response =
serviceAttachmentsClient
.patchAsync(project, region, serviceAttachment, serviceAttachmentResource)
.get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The region scoping this request and should conform to RFC1035. |
serviceAttachment | String The resource id of the ServiceAttachment to patch. It should conform to RFC1035 resource name or be a string form on an unsigned long number. |
serviceAttachmentResource | ServiceAttachment The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
patchCallable()
public final UnaryCallable<PatchServiceAttachmentRequest,Operation> patchCallable()
Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
PatchServiceAttachmentRequest request =
PatchServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachment("serviceAttachment-398467656")
.setServiceAttachmentResource(ServiceAttachment.newBuilder().build())
.build();
ApiFuture<Operation> future = serviceAttachmentsClient.patchCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<PatchServiceAttachmentRequest,Operation> |
patchOperationCallable()
public final OperationCallable<PatchServiceAttachmentRequest,Operation,Operation> patchOperationCallable()
Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
PatchServiceAttachmentRequest request =
PatchServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setServiceAttachment("serviceAttachment-398467656")
.setServiceAttachmentResource(ServiceAttachment.newBuilder().build())
.build();
OperationFuture<Operation, Operation> future =
serviceAttachmentsClient.patchOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<PatchServiceAttachmentRequest,Operation,Operation> |
setIamPolicy(SetIamPolicyServiceAttachmentRequest request)
public final Policy setIamPolicy(SetIamPolicyServiceAttachmentRequest request)
Sets the access control policy on the specified resource. Replaces any existing policy.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
SetIamPolicyServiceAttachmentRequest request =
SetIamPolicyServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
.setResource("resource-341064690")
.build();
Policy response = serviceAttachmentsClient.setIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | SetIamPolicyServiceAttachmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Policy |
setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
public final Policy setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
Sets the access control policy on the specified resource. Replaces any existing policy.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String resource = "resource-341064690";
RegionSetPolicyRequest regionSetPolicyRequestResource =
RegionSetPolicyRequest.newBuilder().build();
Policy response =
serviceAttachmentsClient.setIamPolicy(
project, region, resource, regionSetPolicyRequestResource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
resource | String Name or id of the resource for this request. |
regionSetPolicyRequestResource | RegionSetPolicyRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyServiceAttachmentRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replaces any existing policy.
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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
SetIamPolicyServiceAttachmentRequest request =
SetIamPolicyServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
.setResource("resource-341064690")
.build();
ApiFuture<Policy> future =
serviceAttachmentsClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetIamPolicyServiceAttachmentRequest,Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsServiceAttachmentRequest request)
public final TestPermissionsResponse testIamPermissions(TestIamPermissionsServiceAttachmentRequest request)
Returns permissions that a caller has on the specified 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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
TestIamPermissionsServiceAttachmentRequest request =
TestIamPermissionsServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setResource("resource-341064690")
.setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
.build();
TestPermissionsResponse response = serviceAttachmentsClient.testIamPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request | TestIamPermissionsServiceAttachmentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse |
testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)
public final TestPermissionsResponse testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified 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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String resource = "resource-341064690";
TestPermissionsRequest testPermissionsRequestResource =
TestPermissionsRequest.newBuilder().build();
TestPermissionsResponse response =
serviceAttachmentsClient.testIamPermissions(
project, region, resource, testPermissionsRequestResource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
resource | String Name or id of the resource for this request. |
testPermissionsRequestResource | TestPermissionsRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsServiceAttachmentRequest,TestPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified 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 (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
TestIamPermissionsServiceAttachmentRequest request =
TestIamPermissionsServiceAttachmentRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setResource("resource-341064690")
.setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
.build();
ApiFuture<TestPermissionsResponse> future =
serviceAttachmentsClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<TestIamPermissionsServiceAttachmentRequest,TestPermissionsResponse> |