- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: Service for managing Pages.
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().
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetPage |
Retrieves the specified page. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdatePage |
Updates the specified page. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeletePage |
Deletes the specified page. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 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.
Static Methods
create()
public static final PagesClient create()
Constructs an instance of PagesClient with default settings.
Returns | |
---|---|
Type | Description |
PagesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(PagesSettings settings)
public static final PagesClient create(PagesSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
PagesSettings |
Returns | |
---|---|
Type | Description |
PagesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(PagesStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
PagesStub |
Returns | |
---|---|
Type | Description |
PagesClient |
Constructors
PagesClient(PagesSettings settings)
protected PagesClient(PagesSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
PagesSettings |
PagesClient(PagesStub stub)
protected PagesClient(PagesStub stub)
Parameter | |
---|---|
Name | Description |
stub |
PagesStub |
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()
createPage(CreatePageRequest request)
public final Page createPage(CreatePageRequest request)
Creates a page in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
CreatePageRequest request =
CreatePageRequest.newBuilder()
.setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
.setPage(Page.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.build();
Page response = pagesClient.createPage(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreatePageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Page |
createPage(FlowName parent, Page page)
public final Page createPage(FlowName parent, Page page)
Creates a page in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
FlowName parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
Page page = Page.newBuilder().build();
Page response = pagesClient.createPage(parent, page);
}
Parameters | |
---|---|
Name | Description |
parent |
FlowName Required. The flow to create a page for. Format: |
page |
Page Required. The page to create. |
Returns | |
---|---|
Type | Description |
Page |
createPage(String parent, Page page)
public final Page createPage(String parent, Page page)
Creates a page in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
String parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
Page page = Page.newBuilder().build();
Page response = pagesClient.createPage(parent, page);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The flow to create a page for. Format: |
page |
Page Required. The page to create. |
Returns | |
---|---|
Type | Description |
Page |
createPageCallable()
public final UnaryCallable<CreatePageRequest,Page> createPageCallable()
Creates a page in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
CreatePageRequest request =
CreatePageRequest.newBuilder()
.setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
.setPage(Page.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.build();
ApiFuture<Page> future = pagesClient.createPageCallable().futureCall(request);
// Do something.
Page response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreatePageRequest,Page> |
deletePage(DeletePageRequest request)
public final void deletePage(DeletePageRequest request)
Deletes the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
DeletePageRequest request =
DeletePageRequest.newBuilder()
.setName(
PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]").toString())
.setForce(true)
.build();
pagesClient.deletePage(request);
}
Parameter | |
---|---|
Name | Description |
request |
DeletePageRequest The request object containing all of the parameters for the API call. |
deletePage(PageName name)
public final void deletePage(PageName name)
Deletes the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
PageName name = PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]");
pagesClient.deletePage(name);
}
Parameter | |
---|---|
Name | Description |
name |
PageName Required. The name of the page to delete. Format: |
deletePage(String name)
public final void deletePage(String name)
Deletes the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
String name =
PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]").toString();
pagesClient.deletePage(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the page to delete. Format: |
deletePageCallable()
public final UnaryCallable<DeletePageRequest,Empty> deletePageCallable()
Deletes the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
DeletePageRequest request =
DeletePageRequest.newBuilder()
.setName(
PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]").toString())
.setForce(true)
.build();
ApiFuture<Empty> future = pagesClient.deletePageCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeletePageRequest,Empty> |
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 (PagesClient pagesClient = PagesClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = pagesClient.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 (PagesClient pagesClient = PagesClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = pagesClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getPage(GetPageRequest request)
public final Page getPage(GetPageRequest request)
Retrieves the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
GetPageRequest request =
GetPageRequest.newBuilder()
.setName(
PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]").toString())
.setLanguageCode("languageCode-2092349083")
.build();
Page response = pagesClient.getPage(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetPageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Page |
getPage(PageName name)
public final Page getPage(PageName name)
Retrieves the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
PageName name = PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]");
Page response = pagesClient.getPage(name);
}
Parameter | |
---|---|
Name | Description |
name |
PageName Required. The name of the page. Format: |
Returns | |
---|---|
Type | Description |
Page |
getPage(String name)
public final Page getPage(String name)
Retrieves the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
String name =
PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]").toString();
Page response = pagesClient.getPage(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the page. Format: |
Returns | |
---|---|
Type | Description |
Page |
getPageCallable()
public final UnaryCallable<GetPageRequest,Page> getPageCallable()
Retrieves the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
GetPageRequest request =
GetPageRequest.newBuilder()
.setName(
PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]").toString())
.setLanguageCode("languageCode-2092349083")
.build();
ApiFuture<Page> future = pagesClient.getPageCallable().futureCall(request);
// Do something.
Page response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetPageRequest,Page> |
getSettings()
public final PagesSettings getSettings()
Returns | |
---|---|
Type | Description |
PagesSettings |
getStub()
public PagesStub getStub()
Returns | |
---|---|
Type | Description |
PagesStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listLocations(ListLocationsRequest request)
public final PagesClient.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 (PagesClient pagesClient = PagesClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : pagesClient.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 |
PagesClient.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 (PagesClient pagesClient = PagesClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = pagesClient.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,PagesClient.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 (PagesClient pagesClient = PagesClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future = pagesClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listPages(FlowName parent)
public final PagesClient.ListPagesPagedResponse listPages(FlowName parent)
Returns the list of all pages in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
FlowName parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
for (Page element : pagesClient.listPages(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
FlowName Required. The flow to list all pages for. Format: |
Returns | |
---|---|
Type | Description |
PagesClient.ListPagesPagedResponse |
listPages(ListPagesRequest request)
public final PagesClient.ListPagesPagedResponse listPages(ListPagesRequest request)
Returns the list of all pages in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
ListPagesRequest request =
ListPagesRequest.newBuilder()
.setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
.setLanguageCode("languageCode-2092349083")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Page element : pagesClient.listPages(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListPagesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PagesClient.ListPagesPagedResponse |
listPages(String parent)
public final PagesClient.ListPagesPagedResponse listPages(String parent)
Returns the list of all pages in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
String parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
for (Page element : pagesClient.listPages(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The flow to list all pages for. Format: |
Returns | |
---|---|
Type | Description |
PagesClient.ListPagesPagedResponse |
listPagesCallable()
public final UnaryCallable<ListPagesRequest,ListPagesResponse> listPagesCallable()
Returns the list of all pages in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
ListPagesRequest request =
ListPagesRequest.newBuilder()
.setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
.setLanguageCode("languageCode-2092349083")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListPagesResponse response = pagesClient.listPagesCallable().call(request);
for (Page element : response.getPagesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListPagesRequest,ListPagesResponse> |
listPagesPagedCallable()
public final UnaryCallable<ListPagesRequest,PagesClient.ListPagesPagedResponse> listPagesPagedCallable()
Returns the list of all pages in the specified flow.
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 (PagesClient pagesClient = PagesClient.create()) {
ListPagesRequest request =
ListPagesRequest.newBuilder()
.setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
.setLanguageCode("languageCode-2092349083")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Page> future = pagesClient.listPagesPagedCallable().futureCall(request);
// Do something.
for (Page element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListPagesRequest,ListPagesPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updatePage(Page page, FieldMask updateMask)
public final Page updatePage(Page page, FieldMask updateMask)
Updates the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
Page page = Page.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Page response = pagesClient.updatePage(page, updateMask);
}
Parameters | |
---|---|
Name | Description |
page |
Page Required. The page to update. |
updateMask |
FieldMask The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
Returns | |
---|---|
Type | Description |
Page |
updatePage(UpdatePageRequest request)
public final Page updatePage(UpdatePageRequest request)
Updates the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
UpdatePageRequest request =
UpdatePageRequest.newBuilder()
.setPage(Page.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Page response = pagesClient.updatePage(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdatePageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Page |
updatePageCallable()
public final UnaryCallable<UpdatePageRequest,Page> updatePageCallable()
Updates the specified page.
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 (PagesClient pagesClient = PagesClient.create()) {
UpdatePageRequest request =
UpdatePageRequest.newBuilder()
.setPage(Page.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Page> future = pagesClient.updatePageCallable().futureCall(request);
// Do something.
Page response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdatePageRequest,Page> |