com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.CmekConfigs

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.CmekConfigs

Enclosing class:

DiscoveryEngine.Projects.Locations

public class DiscoveryEngine.Projects.Locations.CmekConfigs
extends Object

The "cmekConfigs" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.CmekConfigs.Delete
class	DiscoveryEngine.Projects.Locations.CmekConfigs.Get
class	DiscoveryEngine.Projects.Locations.CmekConfigs.List
class	DiscoveryEngine.Projects.Locations.CmekConfigs.Patch

Constructor Summary

Constructors

Constructor and Description
CmekConfigs()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.CmekConfigs.Delete	delete(String name) De-provisions a CmekConfig.
DiscoveryEngine.Projects.Locations.CmekConfigs.Get	get(String name) Gets the CmekConfig.
DiscoveryEngine.Projects.Locations.CmekConfigs.List	list(String parent) Lists all the CmekConfigs with the project.
DiscoveryEngine.Projects.Locations.CmekConfigs.Patch	patch(String name, GoogleCloudDiscoveryengineV1CmekConfig content) Provisions a CMEK key for use in a location of a customer's project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmekConfigs

public CmekConfigs()

Method Detail

delete

public DiscoveryEngine.Projects.Locations.CmekConfigs.Delete delete(String name)
                                                             throws IOException

De-provisions a CmekConfig. Create a request for the method "cmekConfigs.delete". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CmekConfig to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.

Returns:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.CmekConfigs.Get get(String name)
                                                       throws IOException

Gets the CmekConfig. Create a request for the method "cmekConfigs.get". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of CmekConfig, such as `projects/locations/cmekConfig` or `projects/locations/cmekConfigs`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns:

the request

Throws:

IOException

list

public DiscoveryEngine.Projects.Locations.CmekConfigs.List list(String parent)
                                                         throws IOException

Lists all the CmekConfigs with the project. Create a request for the method "cmekConfigs.list". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.

Returns:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.CmekConfigs.Patch patch(String name,
                                                                  GoogleCloudDiscoveryengineV1CmekConfig content)
                                                           throws IOException

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. Create a request for the method "cmekConfigs.patch". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.

content - the GoogleCloudDiscoveryengineV1CmekConfig

Returns:

the request

Throws:

IOException