Class ServiceAttachmentsClient (1.11.0)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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:

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

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ServiceAttachmentsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ServiceAttachmentsSettings serviceAttachmentsSettings =
     ServiceAttachmentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServiceAttachmentsClient serviceAttachmentsClient =
     ServiceAttachmentsClient.create(serviceAttachmentsSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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.

Inheritance

java.lang.Object > ServiceAttachmentsClient

Implements

BackgroundResource

Static Methods

create()

public static final ServiceAttachmentsClient create()

Constructs an instance of ServiceAttachmentsClient with default settings.

Returns
TypeDescription
ServiceAttachmentsClient
Exceptions
TypeDescription
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
NameDescription
settingsServiceAttachmentsSettings
Returns
TypeDescription
ServiceAttachmentsClient
Exceptions
TypeDescription
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
NameDescription
stubServiceAttachmentsStub
Returns
TypeDescription
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
NameDescription
settingsServiceAttachmentsSettings

ServiceAttachmentsClient(ServiceAttachmentsStub stub)

protected ServiceAttachmentsClient(ServiceAttachmentsStub stub)
Parameter
NameDescription
stubServiceAttachmentsStub

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestAggregatedListServiceAttachmentsRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, ServiceAttachmentsScopedList> element :
       serviceAttachmentsClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
projectString

Name of the project scoping this request.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<AggregatedListServiceAttachmentsRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestDeleteServiceAttachmentRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
projectString

Project ID for this request.

regionString

Name of the region of this request.

serviceAttachmentString

Name of the ServiceAttachment resource to delete.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestGetServiceAttachmentRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
projectString

Project ID for this request.

regionString

Name of the region of this request.

serviceAttachmentString

Name of the ServiceAttachment resource to return.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestGetIamPolicyServiceAttachmentRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
projectString

Project ID for this request.

regionString

The name of the region for this request.

resourceString

Name or id of the resource for this request.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<GetIamPolicyServiceAttachmentRequest,Policy>

getSettings()

public final ServiceAttachmentsSettings getSettings()
Returns
TypeDescription
ServiceAttachmentsSettings

getStub()

public ServiceAttachmentsStub getStub()
Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestInsertServiceAttachmentRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
projectString

Project ID for this request.

regionString

Name of the region of this request.

serviceAttachmentResourceServiceAttachment

The body resource for this request

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
OperationCallable<InsertServiceAttachmentRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestListServiceAttachmentsRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServiceAttachmentsClient serviceAttachmentsClient = ServiceAttachmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (ServiceAttachment element :
       serviceAttachmentsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

regionString

Name of the region of this request.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestPatchServiceAttachmentRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
projectString

Project ID for this request.

regionString

The region scoping this request and should conform to RFC1035.

serviceAttachmentString

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.

serviceAttachmentResourceServiceAttachment

The body resource for this request

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestSetIamPolicyServiceAttachmentRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
projectString

Project ID for this request.

regionString

The name of the region for this request.

resourceString

Name or id of the resource for this request.

regionSetPolicyRequestResourceRegionSetPolicyRequest

The body resource for this request

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestTestIamPermissionsServiceAttachmentRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
projectString

Project ID for this request.

regionString

The name of the region for this request.

resourceString

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<TestIamPermissionsServiceAttachmentRequest,TestPermissionsResponse>