Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource

The "engines" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource
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.v1alpha
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource

Constructors

EnginesResource(IClientService)

Constructs a new resource.

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

Properties

CompletionConfig

Gets the CompletionConfig resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.CompletionConfigResource CompletionConfig { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.CompletionConfigResource

Controls

Gets the Controls resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ControlsResource Controls { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ControlsResource

Conversations

Gets the Conversations resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource Conversations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource

Operations

Gets the Operations resource.

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

ServingConfigs

Gets the ServingConfigs resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource ServingConfigs { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource

Sessions

Gets the Sessions resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource Sessions { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource

WidgetConfigs

Gets the WidgetConfigs resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.WidgetConfigsResource WidgetConfigs { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.WidgetConfigsResource

Methods

Create(GoogleCloudDiscoveryengineV1alphaEngine, string)

Creates a Engine.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.CreateRequest Create(GoogleCloudDiscoveryengineV1alphaEngine body, string parent)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1alphaEngine body

The body of the request.

string parent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.CreateRequest

Delete(string)

Deletes a Engine.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Full resource name of Engine, such as projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.DeleteRequest

Get(string)

Gets a Engine.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Full resource name of Engine, such as projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.GetRequest

List(string)

Lists all the Engines associated with the project.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ListRequest

Patch(GoogleCloudDiscoveryengineV1alphaEngine, string)

Updates an Engine

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.PatchRequest Patch(GoogleCloudDiscoveryengineV1alphaEngine body, string name)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1alphaEngine body

The body of the request.

string name

Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.PatchRequest

Pause(GoogleCloudDiscoveryengineV1alphaPauseEngineRequest, string)

Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.PauseRequest Pause(GoogleCloudDiscoveryengineV1alphaPauseEngineRequest body, string name)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1alphaPauseEngineRequest body

The body of the request.

string name

Required. The name of the engine to pause. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.PauseRequest

Resume(GoogleCloudDiscoveryengineV1alphaResumeEngineRequest, string)

Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ResumeRequest Resume(GoogleCloudDiscoveryengineV1alphaResumeEngineRequest body, string name)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1alphaResumeEngineRequest body

The body of the request.

string name

Required. The name of the engine to resume. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ResumeRequest

Tune(GoogleCloudDiscoveryengineV1alphaTuneEngineRequest, string)

Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.TuneRequest Tune(GoogleCloudDiscoveryengineV1alphaTuneEngineRequest body, string name)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1alphaTuneEngineRequest body

The body of the request.

string name

Required. The resource name of the engine to tune. Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.TuneRequest
In this article
Back to top Generated by DocFX