com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine

public class DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites
extends Object

The "targetSites" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.BatchCreate
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Create
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Delete
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Get
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.List
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Operations The "operations" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Patch

Constructor Summary

Constructors

Constructor and Description
TargetSites()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.BatchCreate	batchCreate(String parent, GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest content) Creates TargetSite in a batch.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Create	create(String parent, GoogleCloudDiscoveryengineV1TargetSite content) Creates a TargetSite.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Delete	delete(String name) Deletes a TargetSite.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Get	get(String name) Gets a TargetSite.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.List	list(String parent) Gets a list of TargetSites.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Operations	operations() An accessor for creating requests from the Operations collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Patch	patch(String name, GoogleCloudDiscoveryengineV1TargetSite content) Updates a TargetSite.

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetSites

public TargetSites()

Method Detail

batchCreate

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.BatchCreate batchCreate(String parent,
                                                                                                                      GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest content)
                                                                                                               throws IOException

Creates TargetSite in a batch. Create a request for the method "targetSites.batchCreate". 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 resource shared by all TargetSites being created. `projects/{project}/locations /{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field.

content - the GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest

Returns:

the request

Throws:

IOException

create

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Create create(String parent,
                                                                                                            GoogleCloudDiscoveryengineV1TargetSite content)
                                                                                                     throws IOException

Creates a TargetSite. Create a request for the method "targetSites.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. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/colle ctions/{collection}/dataStores/{data_store}/siteSearchEngine`.

content - the GoogleCloudDiscoveryengineV1TargetSite

Returns:

the request

Throws:

IOException

delete

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Delete delete(String name)
                                                                                                     throws IOException

Deletes a TargetSite. Create a request for the method "targetSites.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. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collect ions/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.

Returns:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Get get(String name)
                                                                                               throws IOException

Gets a TargetSite. Create a request for the method "targetSites.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. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collect ions/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.

Returns:

the request

Throws:

IOException

list

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.List list(String parent)
                                                                                                 throws IOException

Gets a list of TargetSites. Create a request for the method "targetSites.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 site search engine resource name, such as `projects/{project}/locations/{locati on}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Returns:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.Patch patch(String name,
                                                                                                          GoogleCloudDiscoveryengineV1TargetSite content)
                                                                                                   throws IOException

Updates a TargetSite. Create a request for the method "targetSites.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 - Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{lo cation}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{tar get_site}` The `target_site_id` is system-generated.

content - the GoogleCloudDiscoveryengineV1TargetSite

Returns:

the request

Throws:

IOException

operations

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites.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