EnvironmentsClient (Google Cloud Dialog Flow API Parent 4.9.1 API)

java.lang.Object
- com.google.cloud.dialogflow.v2beta1.EnvironmentsClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class EnvironmentsClient
extends Object
implements BackgroundResource

Service Description: Service for managing [Environments][google.cloud.dialogflow.v2beta1.Environment].

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 (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   GetEnvironmentRequest request =
       GetEnvironmentRequest.newBuilder()
           .setName(
               EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
           .build();
   Environment response = environmentsClient.getEnvironment(request);
 }

Note: close() needs to be called on the EnvironmentsClient 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 EnvironmentsSettings 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
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

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
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

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
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder()
         .setTransportChannelProvider(
             EnvironmentsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

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`	`EnvironmentsClient.GetEnvironmentHistoryFixedSizeCollection`
`static class`	`EnvironmentsClient.GetEnvironmentHistoryPage`
`static class`	`EnvironmentsClient.GetEnvironmentHistoryPagedResponse`
`static class`	`EnvironmentsClient.ListEnvironmentsFixedSizeCollection`
`static class`	`EnvironmentsClient.ListEnvironmentsPage`
`static class`	`EnvironmentsClient.ListEnvironmentsPagedResponse`
`static class`	`EnvironmentsClient.ListLocationsFixedSizeCollection`
`static class`	`EnvironmentsClient.ListLocationsPage`
`static class`	`EnvironmentsClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`EnvironmentsClient(EnvironmentsSettings settings)` Constructs an instance of EnvironmentsClient, using the given settings.
`protected`	`EnvironmentsClient(EnvironmentsStub 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 EnvironmentsClient`	`create()` Constructs an instance of EnvironmentsClient with default settings.
`static EnvironmentsClient`	`create(EnvironmentsSettings settings)` Constructs an instance of EnvironmentsClient, using the given settings.
`static EnvironmentsClient`	`create(EnvironmentsStub stub)` Constructs an instance of EnvironmentsClient, using the given stub for making calls.
`Environment`	`createEnvironment(CreateEnvironmentRequest request)` Creates an agent environment.
`UnaryCallable<CreateEnvironmentRequest,Environment>`	`createEnvironmentCallable()` Creates an agent environment.
`void`	`deleteEnvironment(DeleteEnvironmentRequest request)` Deletes the specified agent environment.
`UnaryCallable<DeleteEnvironmentRequest,Empty>`	`deleteEnvironmentCallable()` Deletes the specified agent environment.
`Environment`	`getEnvironment(GetEnvironmentRequest request)` Retrieves the specified agent environment.
`UnaryCallable<GetEnvironmentRequest,Environment>`	`getEnvironmentCallable()` Retrieves the specified agent environment.
`EnvironmentsClient.GetEnvironmentHistoryPagedResponse`	`getEnvironmentHistory(GetEnvironmentHistoryRequest request)` Gets the history of the specified environment.
`UnaryCallable<GetEnvironmentHistoryRequest,EnvironmentHistory>`	`getEnvironmentHistoryCallable()` Gets the history of the specified environment.
`UnaryCallable<GetEnvironmentHistoryRequest,EnvironmentsClient.GetEnvironmentHistoryPagedResponse>`	`getEnvironmentHistoryPagedCallable()` Gets the history of the specified environment.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`EnvironmentsSettings`	`getSettings()`
`EnvironmentsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`EnvironmentsClient.ListEnvironmentsPagedResponse`	`listEnvironments(AgentName parent)` Returns the list of all non-draft environments of the specified agent.
`EnvironmentsClient.ListEnvironmentsPagedResponse`	`listEnvironments(ListEnvironmentsRequest request)` Returns the list of all non-draft environments of the specified agent.
`EnvironmentsClient.ListEnvironmentsPagedResponse`	`listEnvironments(String parent)` Returns the list of all non-draft environments of the specified agent.
`UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse>`	`listEnvironmentsCallable()` Returns the list of all non-draft environments of the specified agent.
`UnaryCallable<ListEnvironmentsRequest,EnvironmentsClient.ListEnvironmentsPagedResponse>`	`listEnvironmentsPagedCallable()` Returns the list of all non-draft environments of the specified agent.
`EnvironmentsClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,EnvironmentsClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Environment`	`updateEnvironment(UpdateEnvironmentRequest request)` Updates the specified agent environment.
`UnaryCallable<UpdateEnvironmentRequest,Environment>`	`updateEnvironmentCallable()` Updates the specified agent environment.

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

Constructor Detail
- EnvironmentsClient
```
protected EnvironmentsClient(EnvironmentsSettings settings)
                      throws IOException
```
  Constructs an instance of EnvironmentsClient, 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
- EnvironmentsClient
```
protected EnvironmentsClient(EnvironmentsStub stub)
```

Method Detail

create

public static final EnvironmentsClient create()
                                       throws IOException

Constructs an instance of EnvironmentsClient with default settings.

Throws:: IOException

create
```
public static final EnvironmentsClient create(EnvironmentsSettings settings)
                                       throws IOException
```
Constructs an instance of EnvironmentsClient, 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 EnvironmentsClient create(EnvironmentsStub stub)
```
Constructs an instance of EnvironmentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(EnvironmentsSettings).

getSettings

public final EnvironmentsSettings getSettings()

getStub
```
public EnvironmentsStub getStub()
```