PagesClient (Google Dialogflow CX 0.71.0 API)

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

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

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

Service Description: Service for managing [Pages][google.cloud.dialogflow.cx.v3beta1.Page].

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 (PagesClient pagesClient = PagesClient.create()) {
   PageName name = PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]");
   Page response = pagesClient.getPage(name);
 }

Note: close() needs to be called on the PagesClient 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
ListPages	Returns the list of all pages in the specified flow.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listPages(ListPagesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPages(FlowName parent) listPages(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. listPagesPagedCallable() listPagesCallable()
GetPage	Retrieves the specified page.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getPage(GetPageRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getPage(PageName name) getPage(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. getPageCallable()
CreatePage	Creates a page in the specified flow.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createPage(CreatePageRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createPage(FlowName parent, Page page) createPage(String parent, Page page) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createPageCallable()
UpdatePage	Updates the specified page.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updatePage(UpdatePageRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updatePage(Page page, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updatePageCallable()
DeletePage	Deletes the specified page.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deletePage(DeletePageRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deletePage(PageName name) deletePage(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. deletePageCallable()
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 PagesSettings 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
 PagesSettings pagesSettings =
     PagesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PagesClient pagesClient = PagesClient.create(pagesSettings);

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
 PagesSettings pagesSettings = PagesSettings.newBuilder().setEndpoint(myEndpoint).build();
 PagesClient pagesClient = PagesClient.create(pagesSettings);

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
 PagesSettings pagesSettings = PagesSettings.newHttpJsonBuilder().build();
 PagesClient pagesClient = PagesClient.create(pagesSettings);

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`	`PagesClient.ListLocationsFixedSizeCollection`
`static class`	`PagesClient.ListLocationsPage`
`static class`	`PagesClient.ListLocationsPagedResponse`
`static class`	`PagesClient.ListPagesFixedSizeCollection`
`static class`	`PagesClient.ListPagesPage`
`static class`	`PagesClient.ListPagesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PagesClient(PagesSettings settings)` Constructs an instance of PagesClient, using the given settings.
`protected`	`PagesClient(PagesStub 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 PagesClient`	`create()` Constructs an instance of PagesClient with default settings.
`static PagesClient`	`create(PagesSettings settings)` Constructs an instance of PagesClient, using the given settings.
`static PagesClient`	`create(PagesStub stub)` Constructs an instance of PagesClient, using the given stub for making calls.
`Page`	`createPage(CreatePageRequest request)` Creates a page in the specified flow.
`Page`	`createPage(FlowName parent, Page page)` Creates a page in the specified flow.
`Page`	`createPage(String parent, Page page)` Creates a page in the specified flow.
`com.google.api.gax.rpc.UnaryCallable<CreatePageRequest,Page>`	`createPageCallable()` Creates a page in the specified flow.
`void`	`deletePage(DeletePageRequest request)` Deletes the specified page.
`void`	`deletePage(PageName name)` Deletes the specified page.
`void`	`deletePage(String name)` Deletes the specified page.
`com.google.api.gax.rpc.UnaryCallable<DeletePageRequest,com.google.protobuf.Empty>`	`deletePageCallable()` Deletes the specified page.
`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.
`Page`	`getPage(GetPageRequest request)` Retrieves the specified page.
`Page`	`getPage(PageName name)` Retrieves the specified page.
`Page`	`getPage(String name)` Retrieves the specified page.
`com.google.api.gax.rpc.UnaryCallable<GetPageRequest,Page>`	`getPageCallable()` Retrieves the specified page.
`PagesSettings`	`getSettings()`
`PagesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`PagesClient.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,PagesClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`PagesClient.ListPagesPagedResponse`	`listPages(FlowName parent)` Returns the list of all pages in the specified flow.
`PagesClient.ListPagesPagedResponse`	`listPages(ListPagesRequest request)` Returns the list of all pages in the specified flow.
`PagesClient.ListPagesPagedResponse`	`listPages(String parent)` Returns the list of all pages in the specified flow.
`com.google.api.gax.rpc.UnaryCallable<ListPagesRequest,ListPagesResponse>`	`listPagesCallable()` Returns the list of all pages in the specified flow.
`com.google.api.gax.rpc.UnaryCallable<ListPagesRequest,PagesClient.ListPagesPagedResponse>`	`listPagesPagedCallable()` Returns the list of all pages in the specified flow.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Page`	`updatePage(Page page, com.google.protobuf.FieldMask updateMask)` Updates the specified page.
`Page`	`updatePage(UpdatePageRequest request)` Updates the specified page.
`com.google.api.gax.rpc.UnaryCallable<UpdatePageRequest,Page>`	`updatePageCallable()` Updates the specified page.

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

Constructor Detail
- PagesClient
```
protected PagesClient(PagesSettings settings)
               throws IOException
```
  Constructs an instance of PagesClient, 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
- PagesClient
```
protected PagesClient(PagesStub stub)
```

Method Detail

create

public static final PagesClient create()
                                throws IOException

Constructs an instance of PagesClient with default settings.

Throws:: IOException

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

getSettings

public final PagesSettings getSettings()

getStub
```
public PagesStub getStub()
```