com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations

java.lang.Object

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

Enclosing class:

DiscoveryEngine.Projects

public class DiscoveryEngine.Projects.Locations
extends Object

The "locations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.CmekConfigs The "cmekConfigs" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections The "collections" collection of methods.
class	DiscoveryEngine.Projects.Locations.DataStores The "dataStores" collection of methods.
class	DiscoveryEngine.Projects.Locations.GetAclConfig
class	DiscoveryEngine.Projects.Locations.GetCmekConfig
class	DiscoveryEngine.Projects.Locations.GroundingConfigs The "groundingConfigs" collection of methods.
class	DiscoveryEngine.Projects.Locations.IdentityMappingStores The "identityMappingStores" collection of methods.
class	DiscoveryEngine.Projects.Locations.LicenseConfigs The "licenseConfigs" collection of methods.
class	DiscoveryEngine.Projects.Locations.Operations The "operations" collection of methods.
class	DiscoveryEngine.Projects.Locations.Podcasts The "podcasts" collection of methods.
class	DiscoveryEngine.Projects.Locations.RankingConfigs The "rankingConfigs" collection of methods.
class	DiscoveryEngine.Projects.Locations.SetUpDataConnector
class	DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2
class	DiscoveryEngine.Projects.Locations.UpdateAclConfig
class	DiscoveryEngine.Projects.Locations.UpdateCmekConfig
class	DiscoveryEngine.Projects.Locations.UserEvents The "userEvents" collection of methods.
class	DiscoveryEngine.Projects.Locations.UserStores The "userStores" collection of methods.

Constructor Summary

Constructors

Constructor and Description
Locations()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.CmekConfigs	cmekConfigs() An accessor for creating requests from the CmekConfigs collection.
DiscoveryEngine.Projects.Locations.Collections	collections() An accessor for creating requests from the Collections collection.
DiscoveryEngine.Projects.Locations.DataStores	dataStores() An accessor for creating requests from the DataStores collection.
DiscoveryEngine.Projects.Locations.GetAclConfig	getAclConfig(String name) Gets the AclConfig.
DiscoveryEngine.Projects.Locations.GetCmekConfig	getCmekConfig(String name) Gets the CmekConfig.
DiscoveryEngine.Projects.Locations.GroundingConfigs	groundingConfigs() An accessor for creating requests from the GroundingConfigs collection.
DiscoveryEngine.Projects.Locations.IdentityMappingStores	identityMappingStores() An accessor for creating requests from the IdentityMappingStores collection.
DiscoveryEngine.Projects.Locations.LicenseConfigs	licenseConfigs() An accessor for creating requests from the LicenseConfigs collection.
DiscoveryEngine.Projects.Locations.Operations	operations() An accessor for creating requests from the Operations collection.
DiscoveryEngine.Projects.Locations.Podcasts	podcasts() An accessor for creating requests from the Podcasts collection.
DiscoveryEngine.Projects.Locations.RankingConfigs	rankingConfigs() An accessor for creating requests from the RankingConfigs collection.
DiscoveryEngine.Projects.Locations.SetUpDataConnector	setUpDataConnector(String parent, GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest content) Creates a Collection and sets up the DataConnector for it.
DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2	setUpDataConnectorV2(String parent, GoogleCloudDiscoveryengineV1DataConnector content) Creates a Collection and sets up the DataConnector for it.
DiscoveryEngine.Projects.Locations.UpdateAclConfig	updateAclConfig(String name, GoogleCloudDiscoveryengineV1AclConfig content) Default ACL configuration for use in a location of a customer's project.
DiscoveryEngine.Projects.Locations.UpdateCmekConfig	updateCmekConfig(String name, GoogleCloudDiscoveryengineV1CmekConfig content) Provisions a CMEK key for use in a location of a customer's project.
DiscoveryEngine.Projects.Locations.UserEvents	userEvents() An accessor for creating requests from the UserEvents collection.
DiscoveryEngine.Projects.Locations.UserStores	userStores() An accessor for creating requests from the UserStores collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

Locations

public Locations()

Method Detail

getAclConfig

public DiscoveryEngine.Projects.Locations.GetAclConfig getAclConfig(String name)
                                                             throws IOException

Gets the AclConfig. Create a request for the method "locations.getAclConfig". 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 AclConfig, such as `projects/locations/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns:

the request

Throws:

IOException

getCmekConfig

public DiscoveryEngine.Projects.Locations.GetCmekConfig getCmekConfig(String name)
                                                               throws IOException

Gets the CmekConfig. Create a request for the method "locations.getCmekConfig". 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

setUpDataConnector

public DiscoveryEngine.Projects.Locations.SetUpDataConnector setUpDataConnector(String parent,
                                                                                GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest content)
                                                                         throws IOException

Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method. Create a request for the method "locations.setUpDataConnector". 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 of Collection, in the format of `projects/{project}/locations/{location}`.

content - the GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest

Returns:

the request

Throws:

IOException

setUpDataConnectorV2

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 setUpDataConnectorV2(String parent,
                                                                                    GoogleCloudDiscoveryengineV1DataConnector content)
                                                                             throws IOException

Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method. Create a request for the method "locations.setUpDataConnectorV2". 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 of Collection, in the format of `projects/{project}/locations/{location}`.

content - the GoogleCloudDiscoveryengineV1DataConnector

Returns:

the request

Throws:

IOException

updateAclConfig

public DiscoveryEngine.Projects.Locations.UpdateAclConfig updateAclConfig(String name,
                                                                          GoogleCloudDiscoveryengineV1AclConfig content)
                                                                   throws IOException

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. Create a request for the method "locations.updateAclConfig". 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 - Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

content - the GoogleCloudDiscoveryengineV1AclConfig

Returns:

the request

Throws:

IOException

updateCmekConfig

public DiscoveryEngine.Projects.Locations.UpdateCmekConfig updateCmekConfig(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 "locations.updateCmekConfig". 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

cmekConfigs

public DiscoveryEngine.Projects.Locations.CmekConfigs cmekConfigs()

An accessor for creating requests from the CmekConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.CmekConfigs.List request = discoveryengine.cmekConfigs().list(parameters ...)
 

Returns:

the resource collection

collections

public DiscoveryEngine.Projects.Locations.Collections collections()

An accessor for creating requests from the Collections collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Collections.List request = discoveryengine.collections().list(parameters ...)
 

Returns:

the resource collection

dataStores

public DiscoveryEngine.Projects.Locations.DataStores dataStores()

An accessor for creating requests from the DataStores collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.DataStores.List request = discoveryengine.dataStores().list(parameters ...)
 

Returns:

the resource collection

groundingConfigs

public DiscoveryEngine.Projects.Locations.GroundingConfigs groundingConfigs()

An accessor for creating requests from the GroundingConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.GroundingConfigs.List request = discoveryengine.groundingConfigs().list(parameters ...)
 

Returns:

the resource collection

identityMappingStores

public DiscoveryEngine.Projects.Locations.IdentityMappingStores identityMappingStores()

An accessor for creating requests from the IdentityMappingStores collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.IdentityMappingStores.List request = discoveryengine.identityMappingStores().list(parameters ...)
 

Returns:

the resource collection

licenseConfigs

public DiscoveryEngine.Projects.Locations.LicenseConfigs licenseConfigs()

An accessor for creating requests from the LicenseConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.LicenseConfigs.List request = discoveryengine.licenseConfigs().list(parameters ...)
 

Returns:

the resource collection

operations

public DiscoveryEngine.Projects.Locations.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Operations.List request = discoveryengine.operations().list(parameters ...)
 

Returns:

the resource collection

podcasts

public DiscoveryEngine.Projects.Locations.Podcasts podcasts()

An accessor for creating requests from the Podcasts collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Podcasts.List request = discoveryengine.podcasts().list(parameters ...)
 

Returns:

the resource collection

rankingConfigs

public DiscoveryEngine.Projects.Locations.RankingConfigs rankingConfigs()

An accessor for creating requests from the RankingConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.RankingConfigs.List request = discoveryengine.rankingConfigs().list(parameters ...)
 

Returns:

the resource collection

userEvents

public DiscoveryEngine.Projects.Locations.UserEvents userEvents()

An accessor for creating requests from the UserEvents collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.UserEvents.List request = discoveryengine.userEvents().list(parameters ...)
 

Returns:

the resource collection

userStores

public DiscoveryEngine.Projects.Locations.UserStores userStores()

An accessor for creating requests from the UserStores collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.UserStores.List request = discoveryengine.userStores().list(parameters ...)
 

Returns:

the resource collection