Show / Hide Table of Contents

Class ProjectsResource.LocationsResource

The "locations" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DiscoveryEngine.v1beta
Assembly: Google.Apis.DiscoveryEngine.v1beta.dll
Syntax
public class ProjectsResource.LocationsResource

Constructors

LocationsResource(IClientService)

Constructs a new resource.

Declaration
public LocationsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

CmekConfigs

Gets the CmekConfigs resource.

Declaration
public virtual ProjectsResource.LocationsResource.CmekConfigsResource CmekConfigs { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CmekConfigsResource

Collections

Gets the Collections resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource Collections { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource

DataStores

Gets the DataStores resource.

Declaration
public virtual ProjectsResource.LocationsResource.DataStoresResource DataStores { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.DataStoresResource

Evaluations

Gets the Evaluations resource.

Declaration
public virtual ProjectsResource.LocationsResource.EvaluationsResource Evaluations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.EvaluationsResource

GroundingConfigs

Gets the GroundingConfigs resource.

Declaration
public virtual ProjectsResource.LocationsResource.GroundingConfigsResource GroundingConfigs { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.GroundingConfigsResource

IdentityMappingStores

Gets the IdentityMappingStores resource.

Declaration
public virtual ProjectsResource.LocationsResource.IdentityMappingStoresResource IdentityMappingStores { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.IdentityMappingStoresResource

Operations

Gets the Operations resource.

Declaration
public virtual ProjectsResource.LocationsResource.OperationsResource Operations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.OperationsResource

Podcasts

Gets the Podcasts resource.

Declaration
public virtual ProjectsResource.LocationsResource.PodcastsResource Podcasts { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.PodcastsResource

RankingConfigs

Gets the RankingConfigs resource.

Declaration
public virtual ProjectsResource.LocationsResource.RankingConfigsResource RankingConfigs { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.RankingConfigsResource

SampleQuerySets

Gets the SampleQuerySets resource.

Declaration
public virtual ProjectsResource.LocationsResource.SampleQuerySetsResource SampleQuerySets { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.SampleQuerySetsResource

UserEvents

Gets the UserEvents resource.

Declaration
public virtual ProjectsResource.LocationsResource.UserEventsResource UserEvents { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.UserEventsResource

UserStores

Gets the UserStores resource.

Declaration
public virtual ProjectsResource.LocationsResource.UserStoresResource UserStores { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.UserStoresResource

Methods

GetCmekConfig(string)

Gets the CmekConfig.

Declaration
public virtual ProjectsResource.LocationsResource.GetCmekConfigRequest GetCmekConfig(string name)
Parameters
Type Name Description
string 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
Type Description
ProjectsResource.LocationsResource.GetCmekConfigRequest

ObtainCrawlRate(GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest, string)

Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.

Declaration
public virtual ProjectsResource.LocationsResource.ObtainCrawlRateRequest ObtainCrawlRate(GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest body, string location)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest body

The body of the request.

string location

Required. The location resource where crawl rate management will be performed. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.ObtainCrawlRateRequest

RemoveDedicatedCrawlRate(GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest, string)

Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.

Declaration
public virtual ProjectsResource.LocationsResource.RemoveDedicatedCrawlRateRequest RemoveDedicatedCrawlRate(GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest body, string location)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest body

The body of the request.

string location

Required. The location resource where crawl rate management will be performed. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.RemoveDedicatedCrawlRateRequest

SetDedicatedCrawlRate(GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest, string)

Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.

Declaration
public virtual ProjectsResource.LocationsResource.SetDedicatedCrawlRateRequest SetDedicatedCrawlRate(GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest body, string location)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest body

The body of the request.

string location

Required. The location resource where crawl rate management will be performed. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.SetDedicatedCrawlRateRequest

UpdateCmekConfig(GoogleCloudDiscoveryengineV1betaCmekConfig, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.UpdateCmekConfigRequest UpdateCmekConfig(GoogleCloudDiscoveryengineV1betaCmekConfig body, string name)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1betaCmekConfig body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.LocationsResource.UpdateCmekConfigRequest
In this article
Back to top Generated by DocFX