Class SecuritySettingsServiceClient (0.64.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

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 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. 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.

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.

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:


 // 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:


 // 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:


 // 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.

Inheritance

java.lang.Object > SecuritySettingsServiceClient

Static Methods

create()

public static final SecuritySettingsServiceClient create()

Constructs an instance of SecuritySettingsServiceClient with default settings.

Returns
Type Description
SecuritySettingsServiceClient
Exceptions
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.

Parameter
Name Description
settings SecuritySettingsServiceSettings
Returns
Type Description
SecuritySettingsServiceClient
Exceptions
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).

Parameter
Name Description
stub SecuritySettingsServiceStub
Returns
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.

Parameter
Name Description
settings SecuritySettingsServiceSettings

SecuritySettingsServiceClient(SecuritySettingsServiceStub stub)

protected SecuritySettingsServiceClient(SecuritySettingsServiceStub stub)
Parameter
Name Description
stub SecuritySettingsServiceStub

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()

createSecuritySettings(CreateSecuritySettingsRequest request)

public final SecuritySettings createSecuritySettings(CreateSecuritySettingsRequest request)

Create security settings in the specified 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 (SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create()) {
   CreateSecuritySettingsRequest request =
       CreateSecuritySettingsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSecuritySettings(SecuritySettings.newBuilder().build())
           .build();
   SecuritySettings response = securitySettingsServiceClient.createSecuritySettings(request);
 }
Parameter
Name Description
request CreateSecuritySettingsRequest

The request object containing all of the parameters for the API call.
Returns
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 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);
 }
Parameters
Name Description
parent LocationName

Required. The location to create an SecuritySettings for. Format: projects/<Project ID>/locations/<Location ID>.
securitySettings SecuritySettings

Required. The security settings to create.
Returns
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 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);
 }
Parameters
Name Description
parent String

Required. The location to create an SecuritySettings for. Format: projects/<Project ID>/locations/<Location ID>.
securitySettings SecuritySettings

Required. The security settings to create.
Returns
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 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<SecuritySettings> future =
       securitySettingsServiceClient.createSecuritySettingsCallable().futureCall(request);
   // Do something.
   SecuritySettings response = future.get();
 }
Returns
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 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);
 }
Parameter
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 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);
 }
Parameter
Name Description
name SecuritySettingsName

Required. The name of the SecuritySettings to delete. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

deleteSecuritySettings(String name)

public final void deleteSecuritySettings(String name)

Deletes the specified SecuritySettings.

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 (SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create()) {
   String name =
       SecuritySettingsName.of("[PROJECT]", "[LOCATION]", "[SECURITY_SETTINGS]").toString();
   securitySettingsServiceClient.deleteSecuritySettings(name);
 }
Parameter
Name Description
name String

Required. The name of the SecuritySettings to delete. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

deleteSecuritySettingsCallable()

public final UnaryCallable<DeleteSecuritySettingsRequest,Empty> deleteSecuritySettingsCallable()

Deletes the specified SecuritySettings.

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 (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();
 }
Returns
Type Description
UnaryCallable<DeleteSecuritySettingsRequest,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 (SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = securitySettingsServiceClient.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 (SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       securitySettingsServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

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 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);
 }
Parameter
Name Description
request GetSecuritySettingsRequest

The request object containing all of the parameters for the API call.
Returns
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 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);
 }
Parameter
Name Description
name SecuritySettingsName

Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<security settings ID>.
Returns
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 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);
 }
Parameter
Name Description
name String

Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<security settings ID>.
Returns
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 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<SecuritySettings> future =
       securitySettingsServiceClient.getSecuritySettingsCallable().futureCall(request);
   // Do something.
   SecuritySettings response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSecuritySettingsRequest,SecuritySettings>

getSettings()

public final SecuritySettingsServiceSettings getSettings()
Returns
Type Description
SecuritySettingsServiceSettings

getStub()

public SecuritySettingsServiceStub getStub()
Returns
Type Description
SecuritySettingsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final SecuritySettingsServiceClient.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 (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);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SecuritySettingsServiceClient.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 (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;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,SecuritySettingsServiceClient.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 (SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       securitySettingsServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

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 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);
   }
 }
Parameter
Name Description
request ListSecuritySettingsRequest

The request object containing all of the parameters for the API call.
Returns
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 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);
   }
 }
Parameter
Name Description
parent LocationName

Required. The location to list all security settings for. Format: projects/<Project ID>/locations/<Location ID>.
Returns
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 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);
   }
 }
Parameter
Name Description
parent String

Required. The location to list all security settings for. Format: projects/<Project ID>/locations/<Location ID>.
Returns
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 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;
     }
   }
 }
Returns
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 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<SecuritySettings> future =
       securitySettingsServiceClient.listSecuritySettingsPagedCallable().futureCall(request);
   // Do something.
   for (SecuritySettings element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
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 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);
 }
Parameters
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.
Returns
Type Description
SecuritySettings

updateSecuritySettings(UpdateSecuritySettingsRequest request)

public final SecuritySettings updateSecuritySettings(UpdateSecuritySettingsRequest request)

Updates the specified SecuritySettings.

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 (SecuritySettingsServiceClient securitySettingsServiceClient =
     SecuritySettingsServiceClient.create()) {
   UpdateSecuritySettingsRequest request =
       UpdateSecuritySettingsRequest.newBuilder()
           .setSecuritySettings(SecuritySettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   SecuritySettings response = securitySettingsServiceClient.updateSecuritySettings(request);
 }
Parameter
Name Description
request UpdateSecuritySettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SecuritySettings

updateSecuritySettingsCallable()

public final UnaryCallable<UpdateSecuritySettingsRequest,SecuritySettings> updateSecuritySettingsCallable()

Updates the specified SecuritySettings.

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 (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();
 }
Returns
Type Description
UnaryCallable<UpdateSecuritySettingsRequest,SecuritySettings>