Class MessagesV1Beta3Client (0.24.0)

Version 0.24.0

• 0.59.0 (latest)
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

public class MessagesV1Beta3Client implements BackgroundResource

Service Description: The Dataflow Messages API is used for monitoring the progress of Dataflow jobs.

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 (MessagesV1Beta3Client messagesV1Beta3Client = MessagesV1Beta3Client.create()) {
   ListJobMessagesRequest request =
       ListJobMessagesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setMinimumImportance(JobMessageImportance.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   for (JobMessage element : messagesV1Beta3Client.listJobMessages(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Note: close() needs to be called on the MessagesV1Beta3Client 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 MessagesV1Beta3Settings 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
 MessagesV1Beta3Settings messagesV1Beta3Settings =
     MessagesV1Beta3Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MessagesV1Beta3Client messagesV1Beta3Client =
     MessagesV1Beta3Client.create(messagesV1Beta3Settings);
 

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
 MessagesV1Beta3Settings messagesV1Beta3Settings =
     MessagesV1Beta3Settings.newBuilder().setEndpoint(myEndpoint).build();
 MessagesV1Beta3Client messagesV1Beta3Client =
     MessagesV1Beta3Client.create(messagesV1Beta3Settings);
 

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
 MessagesV1Beta3Settings messagesV1Beta3Settings =
     MessagesV1Beta3Settings.newHttpJsonBuilder().build();
 MessagesV1Beta3Client messagesV1Beta3Client =
     MessagesV1Beta3Client.create(messagesV1Beta3Settings);
 

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

Inheritance

java.lang.Object > MessagesV1Beta3Client

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final MessagesV1Beta3Client create()

Constructs an instance of MessagesV1Beta3Client with default settings.

Returns
Type	Description
MessagesV1Beta3Client

Exceptions
Type	Description
IOException

create(MessagesV1Beta3Settings settings)

public static final MessagesV1Beta3Client create(MessagesV1Beta3Settings settings)

Constructs an instance of MessagesV1Beta3Client, 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	MessagesV1Beta3Settings

Returns
Type	Description
MessagesV1Beta3Client

Exceptions
Type	Description
IOException

create(MessagesV1Beta3Stub stub)

public static final MessagesV1Beta3Client create(MessagesV1Beta3Stub stub)

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

Parameter
Name	Description
stub	MessagesV1Beta3Stub

Returns
Type	Description
MessagesV1Beta3Client

Constructors

MessagesV1Beta3Client(MessagesV1Beta3Settings settings)

protected MessagesV1Beta3Client(MessagesV1Beta3Settings settings)

Constructs an instance of MessagesV1Beta3Client, 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	MessagesV1Beta3Settings

MessagesV1Beta3Client(MessagesV1Beta3Stub stub)

protected MessagesV1Beta3Client(MessagesV1Beta3Stub stub)

Parameter
Name	Description
stub	MessagesV1Beta3Stub

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()

getSettings()

public final MessagesV1Beta3Settings getSettings()

Returns
Type	Description
MessagesV1Beta3Settings

getStub()

public MessagesV1Beta3Stub getStub()

Returns
Type	Description
MessagesV1Beta3Stub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listJobMessages(ListJobMessagesRequest request)

public final MessagesV1Beta3Client.ListJobMessagesPagedResponse listJobMessages(ListJobMessagesRequest request)

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

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 (MessagesV1Beta3Client messagesV1Beta3Client = MessagesV1Beta3Client.create()) {
   ListJobMessagesRequest request =
       ListJobMessagesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setMinimumImportance(JobMessageImportance.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   for (JobMessage element : messagesV1Beta3Client.listJobMessages(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
MessagesV1Beta3Client.ListJobMessagesPagedResponse

listJobMessagesCallable()

public final UnaryCallable<ListJobMessagesRequest,ListJobMessagesResponse> listJobMessagesCallable()

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

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 (MessagesV1Beta3Client messagesV1Beta3Client = MessagesV1Beta3Client.create()) {
   ListJobMessagesRequest request =
       ListJobMessagesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setMinimumImportance(JobMessageImportance.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   while (true) {
     ListJobMessagesResponse response =
         messagesV1Beta3Client.listJobMessagesCallable().call(request);
     for (JobMessage element : response.getJobMessagesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListJobMessagesRequest,ListJobMessagesResponse>

listJobMessagesPagedCallable()

public final UnaryCallable<ListJobMessagesRequest,MessagesV1Beta3Client.ListJobMessagesPagedResponse> listJobMessagesPagedCallable()

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

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 (MessagesV1Beta3Client messagesV1Beta3Client = MessagesV1Beta3Client.create()) {
   ListJobMessagesRequest request =
       ListJobMessagesRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setMinimumImportance(JobMessageImportance.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   ApiFuture<JobMessage> future =
       messagesV1Beta3Client.listJobMessagesPagedCallable().futureCall(request);
   // Do something.
   for (JobMessage element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListJobMessagesRequest,ListJobMessagesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()