- 0.64.0 (latest)
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 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
public class SecuritySettingsServiceClient implements BackgroundResource
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:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of SecuritySettingsServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SecuritySettingsServiceSettings securitySettingsServiceSettings =
SecuritySettingsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create(securitySettingsServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SecuritySettingsServiceSettings securitySettingsServiceSettings =
SecuritySettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create(securitySettingsServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final SecuritySettingsServiceClient create()
Constructs an instance of SecuritySettingsServiceClient with default settings.
Type | Description |
SecuritySettingsServiceClient |
Type | Description |
IOException |
create(SecuritySettingsServiceSettings settings)
public static final SecuritySettingsServiceClient create(SecuritySettingsServiceSettings settings)
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.
Name | Description |
settings | SecuritySettingsServiceSettings |
Type | Description |
SecuritySettingsServiceClient |
Type | Description |
IOException |
create(SecuritySettingsServiceStub stub)
public static final SecuritySettingsServiceClient create(SecuritySettingsServiceStub stub)
Constructs an instance of SecuritySettingsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SecuritySettingsServiceSettings).
Name | Description |
stub | SecuritySettingsServiceStub |
Type | Description |
SecuritySettingsServiceClient |
Constructors
SecuritySettingsServiceClient(SecuritySettingsServiceSettings settings)
protected SecuritySettingsServiceClient(SecuritySettingsServiceSettings settings)
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.
Name | Description |
settings | SecuritySettingsServiceSettings |
SecuritySettingsServiceClient(SecuritySettingsServiceStub stub)
protected SecuritySettingsServiceClient(SecuritySettingsServiceStub stub)
Name | Description |
stub | SecuritySettingsServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createSecuritySettings(CreateSecuritySettingsRequest request)
public final SecuritySettings createSecuritySettings(CreateSecuritySettingsRequest request)
Create security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
Name | Description |
request | CreateSecuritySettingsRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecuritySettings |
createSecuritySettings(LocationName parent, SecuritySettings securitySettings)
public final SecuritySettings createSecuritySettings(LocationName parent, SecuritySettings securitySettings)
Create security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
SecuritySettings response =
securitySettingsServiceClient.createSecuritySettings(parent, securitySettings);
}
Name | Description |
parent | LocationName Required. The location to create an
SecuritySettings for. Format:
|
securitySettings | SecuritySettings Required. The security settings to create. |
Type | Description |
SecuritySettings |
createSecuritySettings(String parent, SecuritySettings securitySettings)
public final SecuritySettings createSecuritySettings(String parent, SecuritySettings securitySettings)
Create security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
SecuritySettings response =
securitySettingsServiceClient.createSecuritySettings(parent, securitySettings);
}
Name | Description |
parent | String Required. The location to create an
SecuritySettings for. Format:
|
securitySettings | SecuritySettings Required. The security settings to create. |
Type | Description |
SecuritySettings |
createSecuritySettingsCallable()
public final UnaryCallable<CreateSecuritySettingsRequest,SecuritySettings> createSecuritySettingsCallable()
Create security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
CreateSecuritySettingsRequest request =
CreateSecuritySettingsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSecuritySettings(SecuritySettings.newBuilder().build())
.build();
ApiFuture<SecuritySettings> future =
securitySettingsServiceClient.createSecuritySettingsCallable().futureCall(request);
// Do something.
SecuritySettings response = future.get();
}
Type | Description |
UnaryCallable<CreateSecuritySettingsRequest,SecuritySettings> |
deleteSecuritySettings(DeleteSecuritySettingsRequest request)
public final void deleteSecuritySettings(DeleteSecuritySettingsRequest request)
Deletes the specified SecuritySettings.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
DeleteSecuritySettingsRequest request =
DeleteSecuritySettingsRequest.newBuilder()
.setName(
SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]")
.toString())
.build();
securitySettingsServiceClient.deleteSecuritySettings(request);
}
Name | Description |
request | DeleteSecuritySettingsRequest The request object containing all of the parameters for the API call. |
deleteSecuritySettings(SecuritySettingsName name)
public final void deleteSecuritySettings(SecuritySettingsName name)
Deletes the specified SecuritySettings.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
SecuritySettingsName name =
SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]");
securitySettingsServiceClient.deleteSecuritySettings(name);
}
Name | Description |
name | SecuritySettingsName Required. The name of the
SecuritySettings to delete. Format:
|
deleteSecuritySettings(String name)
public final void deleteSecuritySettings(String name)
Deletes the specified SecuritySettings.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
String name =
SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]").toString();
securitySettingsServiceClient.deleteSecuritySettings(name);
}
Name | Description |
name | String Required. The name of the
SecuritySettings to delete. Format:
|
deleteSecuritySettingsCallable()
public final UnaryCallable<DeleteSecuritySettingsRequest,Empty> deleteSecuritySettingsCallable()
Deletes the specified SecuritySettings.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
DeleteSecuritySettingsRequest request =
DeleteSecuritySettingsRequest.newBuilder()
.setName(
SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]")
.toString())
.build();
ApiFuture<Empty> future =
securitySettingsServiceClient.deleteSecuritySettingsCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteSecuritySettingsRequest,Empty> |
getSecuritySettings(GetSecuritySettingsRequest request)
public final SecuritySettings getSecuritySettings(GetSecuritySettingsRequest request)
Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
GetSecuritySettingsRequest request =
GetSecuritySettingsRequest.newBuilder()
.setName(
SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]")
.toString())
.build();
SecuritySettings response = securitySettingsServiceClient.getSecuritySettings(request);
}
Name | Description |
request | GetSecuritySettingsRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecuritySettings |
getSecuritySettings(SecuritySettingsName name)
public final SecuritySettings getSecuritySettings(SecuritySettingsName name)
Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
SecuritySettingsName name =
SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]");
SecuritySettings response = securitySettingsServiceClient.getSecuritySettings(name);
}
Name | Description |
name | SecuritySettingsName Required. Resource name of the settings. Format: |
Type | Description |
SecuritySettings |
getSecuritySettings(String name)
public final SecuritySettings getSecuritySettings(String name)
Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
String name =
SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]").toString();
SecuritySettings response = securitySettingsServiceClient.getSecuritySettings(name);
}
Name | Description |
name | String Required. Resource name of the settings. Format: |
Type | Description |
SecuritySettings |
getSecuritySettingsCallable()
public final UnaryCallable<GetSecuritySettingsRequest,SecuritySettings> getSecuritySettingsCallable()
Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
GetSecuritySettingsRequest request =
GetSecuritySettingsRequest.newBuilder()
.setName(
SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]")
.toString())
.build();
ApiFuture<SecuritySettings> future =
securitySettingsServiceClient.getSecuritySettingsCallable().futureCall(request);
// Do something.
SecuritySettings response = future.get();
}
Type | Description |
UnaryCallable<GetSecuritySettingsRequest,SecuritySettings> |
getSettings()
public final SecuritySettingsServiceSettings getSettings()
Type | Description |
SecuritySettingsServiceSettings |
getStub()
public SecuritySettingsServiceStub getStub()
Type | Description |
SecuritySettingsServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listSecuritySettings(ListSecuritySettingsRequest request)
public final SecuritySettingsServiceClient.ListSecuritySettingsPagedResponse listSecuritySettings(ListSecuritySettingsRequest request)
Returns the list of all security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
Name | Description |
request | ListSecuritySettingsRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecuritySettingsServiceClient.ListSecuritySettingsPagedResponse |
listSecuritySettings(LocationName parent)
public final SecuritySettingsServiceClient.ListSecuritySettingsPagedResponse listSecuritySettings(LocationName parent)
Returns the list of all security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (SecuritySettings element :
securitySettingsServiceClient.listSecuritySettings(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The location to list all security settings for. Format:
|
Type | Description |
SecuritySettingsServiceClient.ListSecuritySettingsPagedResponse |
listSecuritySettings(String parent)
public final SecuritySettingsServiceClient.ListSecuritySettingsPagedResponse listSecuritySettings(String parent)
Returns the list of all security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (SecuritySettings element :
securitySettingsServiceClient.listSecuritySettings(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The location to list all security settings for. Format:
|
Type | Description |
SecuritySettingsServiceClient.ListSecuritySettingsPagedResponse |
listSecuritySettingsCallable()
public final UnaryCallable<ListSecuritySettingsRequest,ListSecuritySettingsResponse> listSecuritySettingsCallable()
Returns the list of all security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListSecuritySettingsRequest,ListSecuritySettingsResponse> |
listSecuritySettingsPagedCallable()
public final UnaryCallable<ListSecuritySettingsRequest,SecuritySettingsServiceClient.ListSecuritySettingsPagedResponse> listSecuritySettingsPagedCallable()
Returns the list of all security settings in the specified location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
ListSecuritySettingsRequest request =
ListSecuritySettingsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<SecuritySettings> future =
securitySettingsServiceClient.listSecuritySettingsPagedCallable().futureCall(request);
// Do something.
for (SecuritySettings element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListSecuritySettingsRequest,ListSecuritySettingsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateSecuritySettings(SecuritySettings securitySettings, FieldMask updateMask)
public final SecuritySettings updateSecuritySettings(SecuritySettings securitySettings, FieldMask updateMask)
Updates the specified SecuritySettings.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
SecuritySettings response =
securitySettingsServiceClient.updateSecuritySettings(securitySettings, updateMask);
}
Name | Description |
securitySettings | SecuritySettings Required. [SecuritySettings] object that contains values for each of the fields to update. |
updateMask | FieldMask Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
Type | Description |
SecuritySettings |
updateSecuritySettings(UpdateSecuritySettingsRequest request)
public final SecuritySettings updateSecuritySettings(UpdateSecuritySettingsRequest request)
Updates the specified SecuritySettings.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
UpdateSecuritySettingsRequest request =
UpdateSecuritySettingsRequest.newBuilder()
.setSecuritySettings(SecuritySettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
SecuritySettings response = securitySettingsServiceClient.updateSecuritySettings(request);
}
Name | Description |
request | UpdateSecuritySettingsRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecuritySettings |
updateSecuritySettingsCallable()
public final UnaryCallable<UpdateSecuritySettingsRequest,SecuritySettings> updateSecuritySettingsCallable()
Updates the specified SecuritySettings.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecuritySettingsServiceClient securitySettingsServiceClient =
SecuritySettingsServiceClient.create()) {
UpdateSecuritySettingsRequest request =
UpdateSecuritySettingsRequest.newBuilder()
.setSecuritySettings(SecuritySettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<SecuritySettings> future =
securitySettingsServiceClient.updateSecuritySettingsCallable().futureCall(request);
// Do something.
SecuritySettings response = future.get();
}
Type | Description |
UnaryCallable<UpdateSecuritySettingsRequest,SecuritySettings> |