Class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.AlphaEvolveExperimentsResource.AlphaEvolveProgramsResource.ListRequest

List all AlphaEvolvePrograms in a given experiment that follow the criteria provided in the request.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>
DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.AlphaEvolveExperimentsResource.AlphaEvolveProgramsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.AlphaEvolveExperimentsResource.AlphaEvolveProgramsResource.ListRequest : DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>, IClientServiceRequest<GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderBy

Optional. Sorting criterion for the programs. Comma separated list of metrics to sort by and optionally sort order, e.g. "score1 desc, score2". The criteria are applied in the order listed in the field. An implicit criterion of sorting by create_time descending is always applied as the final tie-breaker after all other specified criteria.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

Optional. The maximum number of programs to return. The service may return fewer than this value.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. A page token, received from a previous ListAlphaEvolvePrograms call. Provide this to retrieve the subsequent page.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

StateFilter

Optional. Filter to apply to the programs. Examples: "state_filter = 'COMPLETED'" "state_filter = 'INITIALIZED' OR "state_filter = 'EVALUATING'" If empty, the behavior defaults to listing programs in REGISTRATION_COMPLETE state or processing state is NULL.

Declaration
[RequestParameter("stateFilter", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.AlphaEvolveExperimentsResource.AlphaEvolveProgramsResource.ListRequest.StateFilterEnum? StateFilter { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.AlphaEvolveExperimentsResource.AlphaEvolveProgramsResource.ListRequest.StateFilterEnum?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements