Class DasardsServiceClient (2.24.0)
Stay organized with collections Save and categorize content based on your preferences.

public class DasardsServiceClient implements BackgroundResource

Service Description: Manages Stackdriver dasards. A dasard is an arrangement of data display widgets in a specific layout.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   CreateDasardRequest request =
       CreateDasardRequest.newBuilder()
           .setParent("parent-995424086")
           .setDasard(Dasard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Dasard response = dasardsServiceClient.createDasard(request);
 }

Note: close() needs to be called on the DasardsServiceClient 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 DasardsServiceSettings 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
 DasardsServiceSettings dasardsServiceSettings =
     DasardsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DasardsServiceClient dasardsServiceClient =
     DasardsServiceClient.create(dasardsServiceSettings);

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
 DasardsServiceSettings dasardsServiceSettings =
     DasardsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DasardsServiceClient dasardsServiceClient =
     DasardsServiceClient.create(dasardsServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DasardsServiceSettings dasardsServiceSettings =
     DasardsServiceSettings.newHttpJsonBuilder().build();
 DasardsServiceClient dasardsServiceClient =
     DasardsServiceClient.create(dasardsServiceSettings);

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

Inheritance

java.lang.Object > DasardsServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.wait(long,int)

Static Methods

create()

public static final DasardsServiceClient create()

Constructs an instance of DasardsServiceClient with default settings.

Returns
Type	Description
`DasardsServiceClient`

Exceptions
Type	Description
`IOException`

create(DasardsServiceSettings settings)

public static final DasardsServiceClient create(DasardsServiceSettings settings)

Constructs an instance of DasardsServiceClient, 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`	`DasardsServiceSettings`

Returns
Type	Description
`DasardsServiceClient`

Exceptions
Type	Description
`IOException`

create(DasardsServiceStub stub)

public static final DasardsServiceClient create(DasardsServiceStub stub)

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

Parameter
Name	Description
`stub`	`DasardsServiceStub`

Returns
Type	Description
`DasardsServiceClient`

Constructors

DasardsServiceClient(DasardsServiceSettings settings)

protected DasardsServiceClient(DasardsServiceSettings settings)

Constructs an instance of DasardsServiceClient, 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`	`DasardsServiceSettings`

DasardsServiceClient(DasardsServiceStub stub)

protected DasardsServiceClient(DasardsServiceStub stub)

Parameter
Name	Description
`stub`	`DasardsServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createDasard(CreateDasardRequest request)

public final Dasard createDasard(CreateDasardRequest request)

Creates a new custom dasard. For examples on how you can use this API to create dasards, see Managing dasards by API. This method requires the monitoring.dasards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   CreateDasardRequest request =
       CreateDasardRequest.newBuilder()
           .setParent("parent-995424086")
           .setDasard(Dasard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Dasard response = dasardsServiceClient.createDasard(request);
 }

Parameter
Name	Description
`request`	`CreateDasardRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Dasard`

createDasardCallable()

public final UnaryCallable<CreateDasardRequest,Dasard> createDasardCallable()

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   CreateDasardRequest request =
       CreateDasardRequest.newBuilder()
           .setParent("parent-995424086")
           .setDasard(Dasard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Dasard> future =
       dasardsServiceClient.createDasardCallable().futureCall(request);
   // Do something.
   Dasard response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateDasardRequest,Dasard>`

deleteDasard(DeleteDasardRequest request)

public final void deleteDasard(DeleteDasardRequest request)

Deletes an existing custom dasard.

This method requires the monitoring.dasards.delete permission on the specified dasard. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   DeleteDasardRequest request =
       DeleteDasardRequest.newBuilder()
           .setName(DasardName.of("[PROJECT]", "[DASARD]").toString())
           .build();
   dasardsServiceClient.deleteDasard(request);
 }

Parameter
Name	Description
`request`	`DeleteDasardRequest` The request object containing all of the parameters for the API call.

deleteDasardCallable()

public final UnaryCallable<DeleteDasardRequest,Empty> deleteDasardCallable()

Deletes an existing custom dasard.

This method requires the monitoring.dasards.delete permission on the specified dasard. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   DeleteDasardRequest request =
       DeleteDasardRequest.newBuilder()
           .setName(DasardName.of("[PROJECT]", "[DASARD]").toString())
           .build();
   ApiFuture<Empty> future =
       dasardsServiceClient.deleteDasardCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteDasardRequest,Empty>`

getDasard(GetDasardRequest request)

public final Dasard getDasard(GetDasardRequest request)

Fetches a specific dasard.

This method requires the monitoring.dasards.get permission on the specified dasard. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   GetDasardRequest request =
       GetDasardRequest.newBuilder()
           .setName(DasardName.of("[PROJECT]", "[DASARD]").toString())
           .build();
   Dasard response = dasardsServiceClient.getDasard(request);
 }

Parameter
Name	Description
`request`	`GetDasardRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Dasard`

getDasardCallable()

public final UnaryCallable<GetDasardRequest,Dasard> getDasardCallable()

Fetches a specific dasard.

This method requires the monitoring.dasards.get permission on the specified dasard. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   GetDasardRequest request =
       GetDasardRequest.newBuilder()
           .setName(DasardName.of("[PROJECT]", "[DASARD]").toString())
           .build();
   ApiFuture<Dasard> future =
       dasardsServiceClient.getDasardCallable().futureCall(request);
   // Do something.
   Dasard response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetDasardRequest,Dasard>`

getSettings()

public final DasardsServiceSettings getSettings()

Returns
Type	Description
`DasardsServiceSettings`

getStub()

public DasardsServiceStub getStub()

Returns
Type	Description
`DasardsServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listDasards(ListDasardsRequest request)

public final DasardsServiceClient.ListDasardsPagedResponse listDasards(ListDasardsRequest request)

Lists the existing dasards.

This method requires the monitoring.dasards.list permission on the specified project. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   ListDasardsRequest request =
       ListDasardsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Dasard element : dasardsServiceClient.listDasards(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListDasardsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DasardsServiceClient.ListDasardsPagedResponse`

listDasardsCallable()

public final UnaryCallable<ListDasardsRequest,ListDasardsResponse> listDasardsCallable()

Lists the existing dasards.

This method requires the monitoring.dasards.list permission on the specified project. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   ListDasardsRequest request =
       ListDasardsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDasardsResponse response =
         dasardsServiceClient.listDasardsCallable().call(request);
     for (Dasard element : response.getDasardsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListDasardsRequest,ListDasardsResponse>`

listDasardsPagedCallable()

public final UnaryCallable<ListDasardsRequest,DasardsServiceClient.ListDasardsPagedResponse> listDasardsPagedCallable()

Lists the existing dasards.

This method requires the monitoring.dasards.list permission on the specified project. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   ListDasardsRequest request =
       ListDasardsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Dasard> future =
       dasardsServiceClient.listDasardsPagedCallable().futureCall(request);
   // Do something.
   for (Dasard element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListDasardsRequest,ListDasardsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDasard(UpdateDasardRequest request)

public final Dasard updateDasard(UpdateDasardRequest request)

Replaces an existing custom dasard with a new definition.

This method requires the monitoring.dasards.update permission on the specified dasard. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   UpdateDasardRequest request =
       UpdateDasardRequest.newBuilder()
           .setDasard(Dasard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Dasard response = dasardsServiceClient.updateDasard(request);
 }

Parameter
Name	Description
`request`	`UpdateDasardRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Dasard`

updateDasardCallable()

public final UnaryCallable<UpdateDasardRequest,Dasard> updateDasardCallable()

Replaces an existing custom dasard with a new definition.

This method requires the monitoring.dasards.update permission on the specified dasard. For more information, see Cloud Identity and Access Management.

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 (DasardsServiceClient dasardsServiceClient = DasardsServiceClient.create()) {
   UpdateDasardRequest request =
       UpdateDasardRequest.newBuilder()
           .setDasard(Dasard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Dasard> future =
       dasardsServiceClient.updateDasardCallable().futureCall(request);
   // Do something.
   Dasard response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateDasardRequest,Dasard>`

Class DasardsServiceClient (2.24.0)Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Methods

create()

create(DasardsServiceSettings settings)

create(DasardsServiceStub stub)

Constructors

DasardsServiceClient(DasardsServiceSettings settings)

DasardsServiceClient(DasardsServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createDasard(CreateDasardRequest request)

createDasardCallable()

deleteDasard(DeleteDasardRequest request)

deleteDasardCallable()

getDasard(GetDasardRequest request)

getDasardCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listDasards(ListDasardsRequest request)

listDasardsCallable()

listDasardsPagedCallable()

shutdown()

shutdownNow()

updateDasard(UpdateDasardRequest request)

updateDasardCallable()

Class DasardsServiceClient (2.24.0)
Stay organized with collections Save and categorize content based on your preferences.