Class ChangelogsClient (0.48.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: Service for managing Changelogs.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ChangelogName name = ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]");
   Changelog response = changelogsClient.getChangelog(name);
 }

Note: close() needs to be called on the ChangelogsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListChangelogs

Returns the list of Changelogs.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listChangelogs(ListChangelogsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listChangelogs(AgentName parent)

  • listChangelogs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listChangelogsPagedCallable()

  • listChangelogsCallable()

GetChangelog

Retrieves the specified Changelog.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getChangelog(GetChangelogRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getChangelog(ChangelogName name)

  • getChangelog(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getChangelogCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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 ChangelogsSettings 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
 ChangelogsSettings changelogsSettings =
     ChangelogsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ChangelogsClient changelogsClient = ChangelogsClient.create(changelogsSettings);

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
 ChangelogsSettings changelogsSettings =
     ChangelogsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ChangelogsClient changelogsClient = ChangelogsClient.create(changelogsSettings);

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
 ChangelogsSettings changelogsSettings = ChangelogsSettings.newHttpJsonBuilder().build();
 ChangelogsClient changelogsClient = ChangelogsClient.create(changelogsSettings);

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

Inheritance

java.lang.Object > ChangelogsClient

Static Methods

create()

public static final ChangelogsClient create()

Constructs an instance of ChangelogsClient with default settings.

Returns
Type Description
ChangelogsClient
Exceptions
Type Description
IOException

create(ChangelogsSettings settings)

public static final ChangelogsClient create(ChangelogsSettings settings)

Constructs an instance of ChangelogsClient, 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 ChangelogsSettings
Returns
Type Description
ChangelogsClient
Exceptions
Type Description
IOException

create(ChangelogsStub stub)

public static final ChangelogsClient create(ChangelogsStub stub)

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

Parameter
Name Description
stub ChangelogsStub
Returns
Type Description
ChangelogsClient

Constructors

ChangelogsClient(ChangelogsSettings settings)

protected ChangelogsClient(ChangelogsSettings settings)

Constructs an instance of ChangelogsClient, 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 ChangelogsSettings

ChangelogsClient(ChangelogsStub stub)

protected ChangelogsClient(ChangelogsStub stub)
Parameter
Name Description
stub ChangelogsStub

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

getChangelog(ChangelogName name)

public final Changelog getChangelog(ChangelogName name)

Retrieves the specified Changelog.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ChangelogName name = ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]");
   Changelog response = changelogsClient.getChangelog(name);
 }
Parameter
Name Description
name ChangelogName

Required. The name of the changelog to get. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>.
Returns
Type Description
Changelog

getChangelog(GetChangelogRequest request)

public final Changelog getChangelog(GetChangelogRequest request)

Retrieves the specified Changelog.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   GetChangelogRequest request =
       GetChangelogRequest.newBuilder()
           .setName(
               ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]").toString())
           .build();
   Changelog response = changelogsClient.getChangelog(request);
 }
Parameter
Name Description
request GetChangelogRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Changelog

getChangelog(String name)

public final Changelog getChangelog(String name)

Retrieves the specified Changelog.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   String name =
       ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]").toString();
   Changelog response = changelogsClient.getChangelog(name);
 }
Parameter
Name Description
name String

Required. The name of the changelog to get. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>.
Returns
Type Description
Changelog

getChangelogCallable()

public final UnaryCallable<GetChangelogRequest,Changelog> getChangelogCallable()

Retrieves the specified Changelog.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   GetChangelogRequest request =
       GetChangelogRequest.newBuilder()
           .setName(
               ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]").toString())
           .build();
   ApiFuture<Changelog> future = changelogsClient.getChangelogCallable().futureCall(request);
   // Do something.
   Changelog response = future.get();
 }
Returns
Type Description
UnaryCallable<GetChangelogRequest,Changelog>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = changelogsClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = changelogsClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final ChangelogsSettings getSettings()
Returns
Type Description
ChangelogsSettings

getStub()

public ChangelogsStub getStub()
Returns
Type Description
ChangelogsStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listChangelogs(AgentName parent)

public final ChangelogsClient.ListChangelogsPagedResponse listChangelogs(AgentName parent)

Returns the list of Changelogs.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   for (Changelog element : changelogsClient.listChangelogs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent AgentName

Required. The agent containing the changelogs. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
Returns
Type Description
ChangelogsClient.ListChangelogsPagedResponse

listChangelogs(ListChangelogsRequest request)

public final ChangelogsClient.ListChangelogsPagedResponse listChangelogs(ListChangelogsRequest request)

Returns the list of Changelogs.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ListChangelogsRequest request =
       ListChangelogsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Changelog element : changelogsClient.listChangelogs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListChangelogsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ChangelogsClient.ListChangelogsPagedResponse

listChangelogs(String parent)

public final ChangelogsClient.ListChangelogsPagedResponse listChangelogs(String parent)

Returns the list of Changelogs.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   for (Changelog element : changelogsClient.listChangelogs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The agent containing the changelogs. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
Returns
Type Description
ChangelogsClient.ListChangelogsPagedResponse

listChangelogsCallable()

public final UnaryCallable<ListChangelogsRequest,ListChangelogsResponse> listChangelogsCallable()

Returns the list of Changelogs.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ListChangelogsRequest request =
       ListChangelogsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListChangelogsResponse response = changelogsClient.listChangelogsCallable().call(request);
     for (Changelog element : response.getChangelogsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListChangelogsRequest,ListChangelogsResponse>

listChangelogsPagedCallable()

public final UnaryCallable<ListChangelogsRequest,ChangelogsClient.ListChangelogsPagedResponse> listChangelogsPagedCallable()

Returns the list of Changelogs.

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 (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ListChangelogsRequest request =
       ListChangelogsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Changelog> future =
       changelogsClient.listChangelogsPagedCallable().futureCall(request);
   // Do something.
   for (Changelog element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListChangelogsRequest,ListChangelogsPagedResponse>

listLocations(ListLocationsRequest request)

public final ChangelogsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : changelogsClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ChangelogsClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = changelogsClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,ChangelogsClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       changelogsClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()