ChangelogsClient (Google Dialogflow CX 0.71.0 API)

java.lang.Object
- com.google.cloud.dialogflow.cx.v3beta1.ChangelogsClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class ChangelogsClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing [Changelogs][google.cloud.dialogflow.cx.v3beta1.Changelog].

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChangelogsClient.ListChangelogsFixedSizeCollection`
`static class`	`ChangelogsClient.ListChangelogsPage`
`static class`	`ChangelogsClient.ListChangelogsPagedResponse`
`static class`	`ChangelogsClient.ListLocationsFixedSizeCollection`
`static class`	`ChangelogsClient.ListLocationsPage`
`static class`	`ChangelogsClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ChangelogsClient(ChangelogsSettings settings)` Constructs an instance of ChangelogsClient, using the given settings.
`protected`	`ChangelogsClient(ChangelogsStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ChangelogsClient`	`create()` Constructs an instance of ChangelogsClient with default settings.
`static ChangelogsClient`	`create(ChangelogsSettings settings)` Constructs an instance of ChangelogsClient, using the given settings.
`static ChangelogsClient`	`create(ChangelogsStub stub)` Constructs an instance of ChangelogsClient, using the given stub for making calls.
`Changelog`	`getChangelog(ChangelogName name)` Retrieves the specified Changelog.
`Changelog`	`getChangelog(GetChangelogRequest request)` Retrieves the specified Changelog.
`Changelog`	`getChangelog(String name)` Retrieves the specified Changelog.
`com.google.api.gax.rpc.UnaryCallable<GetChangelogRequest,Changelog>`	`getChangelogCallable()` Retrieves the specified Changelog.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`ChangelogsSettings`	`getSettings()`
`ChangelogsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ChangelogsClient.ListChangelogsPagedResponse`	`listChangelogs(AgentName parent)` Returns the list of Changelogs.
`ChangelogsClient.ListChangelogsPagedResponse`	`listChangelogs(ListChangelogsRequest request)` Returns the list of Changelogs.
`ChangelogsClient.ListChangelogsPagedResponse`	`listChangelogs(String parent)` Returns the list of Changelogs.
`com.google.api.gax.rpc.UnaryCallable<ListChangelogsRequest,ListChangelogsResponse>`	`listChangelogsCallable()` Returns the list of Changelogs.
`com.google.api.gax.rpc.UnaryCallable<ListChangelogsRequest,ChangelogsClient.ListChangelogsPagedResponse>`	`listChangelogsPagedCallable()` Returns the list of Changelogs.
`ChangelogsClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ChangelogsClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ChangelogsClient
```
protected ChangelogsClient(ChangelogsSettings settings)
                    throws IOException
```
  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.
  
  Throws:
  
  IOException
- ChangelogsClient
```
protected ChangelogsClient(ChangelogsStub stub)
```

Method Detail

create

public static final ChangelogsClient create()
                                     throws IOException

Constructs an instance of ChangelogsClient with default settings.

Throws:: IOException

create
```
public static final ChangelogsClient create(ChangelogsSettings settings)
                                     throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final ChangelogsSettings getSettings()

getStub
```
public ChangelogsStub getStub()
```