com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.UserStores

java.lang.Object

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

Enclosing class:

DiscoveryEngine.Projects.Locations

public class DiscoveryEngine.Projects.Locations.UserStores
extends Object

The "userStores" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.UserStores.BatchUpdateUserLicenses
class	DiscoveryEngine.Projects.Locations.UserStores.Create
class	DiscoveryEngine.Projects.Locations.UserStores.Delete
class	DiscoveryEngine.Projects.Locations.UserStores.Get
class	DiscoveryEngine.Projects.Locations.UserStores.LicenseConfigsUsageStats The "licenseConfigsUsageStats" collection of methods.
class	DiscoveryEngine.Projects.Locations.UserStores.Patch
class	DiscoveryEngine.Projects.Locations.UserStores.UserLicenses The "userLicenses" collection of methods.

Constructor Summary

Constructors

Constructor and Description
UserStores()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.UserStores.BatchUpdateUserLicenses	batchUpdateUserLicenses(String parent, GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest content) Updates the User License.
DiscoveryEngine.Projects.Locations.UserStores.Create	create(String parent, GoogleCloudDiscoveryengineV1UserStore content) Creates a new User Store.
DiscoveryEngine.Projects.Locations.UserStores.Delete	delete(String name) Deletes the User Store.
DiscoveryEngine.Projects.Locations.UserStores.Get	get(String name) Gets the User Store.
DiscoveryEngine.Projects.Locations.UserStores.LicenseConfigsUsageStats	licenseConfigsUsageStats() An accessor for creating requests from the LicenseConfigsUsageStats collection.
DiscoveryEngine.Projects.Locations.UserStores.Patch	patch(String name, GoogleCloudDiscoveryengineV1UserStore content) Updates the User Store.
DiscoveryEngine.Projects.Locations.UserStores.UserLicenses	userLicenses() An accessor for creating requests from the UserLicenses collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserStores

public UserStores()

Method Detail

batchUpdateUserLicenses

public DiscoveryEngine.Projects.Locations.UserStores.BatchUpdateUserLicenses batchUpdateUserLicenses(String parent,
                                                                                                     GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest content)
                                                                                              throws IOException

Updates the User License. This method is used for batch assign/unassign licenses to users. Create a request for the method "userStores.batchUpdateUserLicenses". 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 UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.

content - the GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest

Returns:

the request

Throws:

IOException

create

public DiscoveryEngine.Projects.Locations.UserStores.Create create(String parent,
                                                                   GoogleCloudDiscoveryengineV1UserStore content)
                                                            throws IOException

Creates a new User Store. Create a request for the method "userStores.create". 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 collection resource name, such as `projects/{project}/locations/{location}`.

content - the GoogleCloudDiscoveryengineV1UserStore

Returns:

the request

Throws:

IOException

delete

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

Deletes the User Store. Create a request for the method "userStores.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 name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`

Returns:

the request

Throws:

IOException

get

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

Gets the User Store. Create a request for the method "userStores.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. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`

Returns:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.UserStores.Patch patch(String name,
                                                                 GoogleCloudDiscoveryengineV1UserStore content)
                                                          throws IOException

Updates the User Store. Create a request for the method "userStores.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 - Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

content - the GoogleCloudDiscoveryengineV1UserStore

Returns:

the request

Throws:

IOException

licenseConfigsUsageStats

public DiscoveryEngine.Projects.Locations.UserStores.LicenseConfigsUsageStats licenseConfigsUsageStats()

An accessor for creating requests from the LicenseConfigsUsageStats collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.LicenseConfigsUsageStats.List request = discoveryengine.licenseConfigsUsageStats().list(parameters ...)
 

Returns:

the resource collection

userLicenses

public DiscoveryEngine.Projects.Locations.UserStores.UserLicenses userLicenses()

An accessor for creating requests from the UserLicenses collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.UserLicenses.List request = discoveryengine.userLicenses().list(parameters ...)
 

Returns:

the resource collection