com.google.cloud.dialogflow.cx.v3.SecuritySettingsServiceClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-dialogflow-cx Show documentation
Show all versions of google-cloud-dialogflow-cx Show documentation
provides a new way of designing agents, taking a state machine approach to agent design. This gives you clear and explicit control over a conversation, a better end-user experience, and a better development workflow.
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dialogflow.cx.v3;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dialogflow.cx.v3.stub.SecuritySettingsServiceStub;
import com.google.cloud.dialogflow.cx.v3.stub.SecuritySettingsServiceStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for managing security settings for Dialogflow.
*
* 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:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
* SecuritySettings response =
* securitySettingsServiceClient.createSecuritySettings(parent, securitySettings);
* }
* }
*
* Note: close() needs to be called on the SecuritySettingsServiceClient 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
*
*
* CreateSecuritySettings
Create security settings in the specified location.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createSecuritySettings(CreateSecuritySettingsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createSecuritySettings(LocationName parent, SecuritySettings securitySettings)
*
createSecuritySettings(String parent, SecuritySettings securitySettings)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createSecuritySettingsCallable()
*
*
*
*
* GetSecuritySettings
Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The returned settings may be stale by up to 1 minute.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getSecuritySettings(GetSecuritySettingsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getSecuritySettings(SecuritySettingsName name)
*
getSecuritySettings(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.
*
* getSecuritySettingsCallable()
*
*
*
*
* UpdateSecuritySettings
Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateSecuritySettings(UpdateSecuritySettingsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateSecuritySettings(SecuritySettings securitySettings, 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.
*
* updateSecuritySettingsCallable()
*
*
*
*
* ListSecuritySettings
Returns the list of all security settings in the specified location.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listSecuritySettings(ListSecuritySettingsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listSecuritySettings(LocationName parent)
*
listSecuritySettings(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.
*
* listSecuritySettingsPagedCallable()
*
listSecuritySettingsCallable()
*
*
*
*
* DeleteSecuritySettings
Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteSecuritySettings(DeleteSecuritySettingsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteSecuritySettings(SecuritySettingsName name)
*
deleteSecuritySettings(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.
*
* deleteSecuritySettingsCallable()
*
*
*
*
* 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
* SecuritySettingsServiceSettings to create(). For example:
*
*
To customize credentials:
*
*
{@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
* SecuritySettingsServiceSettings securitySettingsServiceSettings =
* SecuritySettingsServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create(securitySettingsServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* SecuritySettingsServiceSettings securitySettingsServiceSettings =
* SecuritySettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create(securitySettingsServiceSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* SecuritySettingsServiceSettings securitySettingsServiceSettings =
* SecuritySettingsServiceSettings.newHttpJsonBuilder().build();
* SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create(securitySettingsServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class SecuritySettingsServiceClient implements BackgroundResource {
private final SecuritySettingsServiceSettings settings;
private final SecuritySettingsServiceStub stub;
/** Constructs an instance of SecuritySettingsServiceClient with default settings. */
public static final SecuritySettingsServiceClient create() throws IOException {
return create(SecuritySettingsServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of SecuritySettingsServiceClient, using the given settings. The channels
* are created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final SecuritySettingsServiceClient create(SecuritySettingsServiceSettings settings)
throws IOException {
return new SecuritySettingsServiceClient(settings);
}
/**
* Constructs an instance of SecuritySettingsServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(SecuritySettingsServiceSettings).
*/
public static final SecuritySettingsServiceClient create(SecuritySettingsServiceStub stub) {
return new SecuritySettingsServiceClient(stub);
}
/**
* Constructs an instance of SecuritySettingsServiceClient, 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.
*/
protected SecuritySettingsServiceClient(SecuritySettingsServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub = ((SecuritySettingsServiceStubSettings) settings.getStubSettings()).createStub();
}
protected SecuritySettingsServiceClient(SecuritySettingsServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final SecuritySettingsServiceSettings getSettings() {
return settings;
}
public SecuritySettingsServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create security settings in the specified location.
*
*
Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
* SecuritySettings response =
* securitySettingsServiceClient.createSecuritySettings(parent, securitySettings);
* }
* }
*
* @param parent Required. The location to create an
* [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @param securitySettings Required. The security settings to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SecuritySettings createSecuritySettings(
LocationName parent, SecuritySettings securitySettings) {
CreateSecuritySettingsRequest request =
CreateSecuritySettingsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setSecuritySettings(securitySettings)
.build();
return createSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create security settings in the specified location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
* SecuritySettings response =
* securitySettingsServiceClient.createSecuritySettings(parent, securitySettings);
* }
* }
*
* @param parent Required. The location to create an
* [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @param securitySettings Required. The security settings to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SecuritySettings createSecuritySettings(
String parent, SecuritySettings securitySettings) {
CreateSecuritySettingsRequest request =
CreateSecuritySettingsRequest.newBuilder()
.setParent(parent)
.setSecuritySettings(securitySettings)
.build();
return createSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create security settings in the specified location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* CreateSecuritySettingsRequest request =
* CreateSecuritySettingsRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setSecuritySettings(SecuritySettings.newBuilder().build())
* .build();
* SecuritySettings response = securitySettingsServiceClient.createSecuritySettings(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SecuritySettings createSecuritySettings(CreateSecuritySettingsRequest request) {
return createSecuritySettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Create security settings in the specified location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* CreateSecuritySettingsRequest request =
* CreateSecuritySettingsRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setSecuritySettings(SecuritySettings.newBuilder().build())
* .build();
* ApiFuture future =
* securitySettingsServiceClient.createSecuritySettingsCallable().futureCall(request);
* // Do something.
* SecuritySettings response = future.get();
* }
* }
*/
public final UnaryCallable
createSecuritySettingsCallable() {
return stub.createSecuritySettingsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The
* returned settings may be stale by up to 1 minute.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* SecuritySettingsName name =
* SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]");
* SecuritySettings response = securitySettingsServiceClient.getSecuritySettings(name);
* }
* }
*
* @param name Required. Resource name of the settings. Format: `projects/<Project
* ID>/locations/<Location ID>/securitySettings/<security settings ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SecuritySettings getSecuritySettings(SecuritySettingsName name) {
GetSecuritySettingsRequest request =
GetSecuritySettingsRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The
* returned settings may be stale by up to 1 minute.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* String name =
* SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]").toString();
* SecuritySettings response = securitySettingsServiceClient.getSecuritySettings(name);
* }
* }
*
* @param name Required. Resource name of the settings. Format: `projects/<Project
* ID>/locations/<Location ID>/securitySettings/<security settings ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SecuritySettings getSecuritySettings(String name) {
GetSecuritySettingsRequest request =
GetSecuritySettingsRequest.newBuilder().setName(name).build();
return getSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The
* returned settings may be stale by up to 1 minute.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* GetSecuritySettingsRequest request =
* GetSecuritySettingsRequest.newBuilder()
* .setName(
* SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]")
* .toString())
* .build();
* SecuritySettings response = securitySettingsServiceClient.getSecuritySettings(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SecuritySettings getSecuritySettings(GetSecuritySettingsRequest request) {
return getSecuritySettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The
* returned settings may be stale by up to 1 minute.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* GetSecuritySettingsRequest request =
* GetSecuritySettingsRequest.newBuilder()
* .setName(
* SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]")
* .toString())
* .build();
* ApiFuture future =
* securitySettingsServiceClient.getSecuritySettingsCallable().futureCall(request);
* // Do something.
* SecuritySettings response = future.get();
* }
* }
*/
public final UnaryCallable
getSecuritySettingsCallable() {
return stub.getSecuritySettingsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* SecuritySettings response =
* securitySettingsServiceClient.updateSecuritySettings(securitySettings, updateMask);
* }
* }
*
* @param securitySettings Required. [SecuritySettings] object that contains values for each of
* the fields to update.
* @param updateMask Required. The mask to control which fields get updated. If the mask is not
* present, all fields will be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SecuritySettings updateSecuritySettings(
SecuritySettings securitySettings, FieldMask updateMask) {
UpdateSecuritySettingsRequest request =
UpdateSecuritySettingsRequest.newBuilder()
.setSecuritySettings(securitySettings)
.setUpdateMask(updateMask)
.build();
return updateSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* UpdateSecuritySettingsRequest request =
* UpdateSecuritySettingsRequest.newBuilder()
* .setSecuritySettings(SecuritySettings.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* SecuritySettings response = securitySettingsServiceClient.updateSecuritySettings(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SecuritySettings updateSecuritySettings(UpdateSecuritySettingsRequest request) {
return updateSecuritySettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* UpdateSecuritySettingsRequest request =
* UpdateSecuritySettingsRequest.newBuilder()
* .setSecuritySettings(SecuritySettings.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* securitySettingsServiceClient.updateSecuritySettingsCallable().futureCall(request);
* // Do something.
* SecuritySettings response = future.get();
* }
* }
*/
public final UnaryCallable
updateSecuritySettingsCallable() {
return stub.updateSecuritySettingsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all security settings in the specified location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* for (SecuritySettings element :
* securitySettingsServiceClient.listSecuritySettings(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The location to list all security settings for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSecuritySettingsPagedResponse listSecuritySettings(LocationName parent) {
ListSecuritySettingsRequest request =
ListSecuritySettingsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all security settings in the specified location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* for (SecuritySettings element :
* securitySettingsServiceClient.listSecuritySettings(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The location to list all security settings for. Format:
* `projects/<Project ID>/locations/<Location ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSecuritySettingsPagedResponse listSecuritySettings(String parent) {
ListSecuritySettingsRequest request =
ListSecuritySettingsRequest.newBuilder().setParent(parent).build();
return listSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all security settings in the specified location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* ListSecuritySettingsRequest request =
* ListSecuritySettingsRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (SecuritySettings element :
* securitySettingsServiceClient.listSecuritySettings(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSecuritySettingsPagedResponse listSecuritySettings(
ListSecuritySettingsRequest request) {
return listSecuritySettingsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all security settings in the specified location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* ListSecuritySettingsRequest request =
* ListSecuritySettingsRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* securitySettingsServiceClient.listSecuritySettingsPagedCallable().futureCall(request);
* // Do something.
* for (SecuritySettings element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listSecuritySettingsPagedCallable() {
return stub.listSecuritySettingsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the list of all security settings in the specified location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* ListSecuritySettingsRequest request =
* ListSecuritySettingsRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListSecuritySettingsResponse response =
* securitySettingsServiceClient.listSecuritySettingsCallable().call(request);
* for (SecuritySettings element : response.getSecuritySettingsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listSecuritySettingsCallable() {
return stub.listSecuritySettingsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* SecuritySettingsName name =
* SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]");
* securitySettingsServiceClient.deleteSecuritySettings(name);
* }
* }
*
* @param name Required. The name of the
* [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to delete. Format:
* `projects/<Project ID>/locations/<Location ID>/securitySettings/<Security
* Settings ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSecuritySettings(SecuritySettingsName name) {
DeleteSecuritySettingsRequest request =
DeleteSecuritySettingsRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* String name =
* SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]").toString();
* securitySettingsServiceClient.deleteSecuritySettings(name);
* }
* }
*
* @param name Required. The name of the
* [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to delete. Format:
* `projects/<Project ID>/locations/<Location ID>/securitySettings/<Security
* Settings ID>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSecuritySettings(String name) {
DeleteSecuritySettingsRequest request =
DeleteSecuritySettingsRequest.newBuilder().setName(name).build();
deleteSecuritySettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* DeleteSecuritySettingsRequest request =
* DeleteSecuritySettingsRequest.newBuilder()
* .setName(
* SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]")
* .toString())
* .build();
* securitySettingsServiceClient.deleteSecuritySettings(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteSecuritySettings(DeleteSecuritySettingsRequest request) {
deleteSecuritySettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* DeleteSecuritySettingsRequest request =
* DeleteSecuritySettingsRequest.newBuilder()
* .setName(
* SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]")
* .toString())
* .build();
* ApiFuture future =
* securitySettingsServiceClient.deleteSecuritySettingsCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
deleteSecuritySettingsCallable() {
return stub.deleteSecuritySettingsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : securitySettingsServiceClient.listLocations(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* securitySettingsServiceClient.listLocationsPagedCallable().futureCall(request);
* // Do something.
* for (Location element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response =
* securitySettingsServiceClient.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;
* }
* }
* }
* }
*/
public final UnaryCallable listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = securitySettingsServiceClient.getLocation(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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 (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future =
* securitySettingsServiceClient.getLocationCallable().futureCall(request);
* // Do something.
* Location response = future.get();
* }
* }
*/
public final UnaryCallable getLocationCallable() {
return stub.getLocationCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListSecuritySettingsPagedResponse
extends AbstractPagedListResponse<
ListSecuritySettingsRequest,
ListSecuritySettingsResponse,
SecuritySettings,
ListSecuritySettingsPage,
ListSecuritySettingsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListSecuritySettingsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListSecuritySettingsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListSecuritySettingsPagedResponse(ListSecuritySettingsPage page) {
super(page, ListSecuritySettingsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListSecuritySettingsPage
extends AbstractPage<
ListSecuritySettingsRequest,
ListSecuritySettingsResponse,
SecuritySettings,
ListSecuritySettingsPage> {
private ListSecuritySettingsPage(
PageContext
context,
ListSecuritySettingsResponse response) {
super(context, response);
}
private static ListSecuritySettingsPage createEmptyPage() {
return new ListSecuritySettingsPage(null, null);
}
@Override
protected ListSecuritySettingsPage createPage(
PageContext
context,
ListSecuritySettingsResponse response) {
return new ListSecuritySettingsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListSecuritySettingsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListSecuritySettingsRequest,
ListSecuritySettingsResponse,
SecuritySettings,
ListSecuritySettingsPage,
ListSecuritySettingsFixedSizeCollection> {
private ListSecuritySettingsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListSecuritySettingsFixedSizeCollection createEmptyCollection() {
return new ListSecuritySettingsFixedSizeCollection(null, 0);
}
@Override
protected ListSecuritySettingsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListSecuritySettingsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListLocationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListLocationsPagedResponse(ListLocationsPage page) {
super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListLocationsPage
extends AbstractPage<
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {
private ListLocationsPage(
PageContext context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}