ml  v1
Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest Class Reference

Lists the jobs in the project. More...

Inheritance diagram for Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest:
Google.Apis.CloudMachineLearningEngine.v1.CloudMachineLearningEngineBaseServiceRequest< Google.Apis.CloudMachineLearningEngine.v1.Data.GoogleCloudMlV1ListJobsResponse >

Public Member Functions

 ListRequest (Google.Apis.Services.IClientService service, string parent)
 Constructs a new List request. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes List parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.CloudMachineLearningEngine.v1.CloudMachineLearningEngineBaseServiceRequest< Google.Apis.CloudMachineLearningEngine.v1.Data.GoogleCloudMlV1ListJobsResponse >
 CloudMachineLearningEngineBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new CloudMachineLearningEngineBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes CloudMachineLearningEngine parameter list. More...
 

Properties

virtual string Parent [get]
 Required. The name of the project for which to list jobs. More...
 
virtual string PageToken [get, set]
 Optional. A page token to request the next page of results. More...
 
virtual System.Nullable< int > PageSize [get, set]
 Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the next_page_token field. More...
 
virtual string Filter [get, set]
 Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census': gcloud ai-platform jobs list –filter='jobId:census*' List all failed jobs with names that start with 'rnn': gcloud ai-platform jobs list –filter='jobId:rnn* AND state:FAILED' For more examples, see the guide to monitoring jobs. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.CloudMachineLearningEngine.v1.CloudMachineLearningEngineBaseServiceRequest< Google.Apis.CloudMachineLearningEngine.v1.Data.GoogleCloudMlV1ListJobsResponse >
virtual System.Nullable< XgafvEnum > Xgafv [get, set]
 V1 error format. More...
 
virtual string AccessToken [get, set]
 OAuth access token. More...
 
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for response. More...
 
virtual string Callback [get, set]
 JSONP More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. More...
 
virtual string UploadType [get, set]
 Legacy upload protocol for media (e.g. "media", "multipart"). More...
 
virtual string UploadProtocol [get, set]
 Upload protocol for media (e.g. "raw", "multipart"). More...
 

Detailed Description

Lists the jobs in the project.

If there are no jobs that match the request parameters, the list request returns an empty response body: {}.

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService  service,
string  parent 
)
inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest.InitParameters ( )
inlineprotected

Initializes List parameter list.

Property Documentation

◆ Filter

virtual string Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest.Filter
getset

Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census': gcloud ai-platform jobs list –filter='jobId:census*' List all failed jobs with names that start with 'rnn': gcloud ai-platform jobs list –filter='jobId:rnn* AND state:FAILED' For more examples, see the guide to monitoring jobs.

summary>Gets the method name.

◆ HttpMethod

override string Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest.HttpMethod
get

summary>Gets the REST path.

◆ MethodName

override string Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest.MethodName
get

summary>Gets the HTTP method.

◆ PageSize

virtual System.Nullable<int> Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest.PageSize
getset

Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the next_page_token field.

The default value is 20, and the maximum page size is 100.

◆ PageToken

virtual string Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest.PageToken
getset

Optional. A page token to request the next page of results.

You get the token from the next_page_token field of the response from the previous call.

◆ Parent

virtual string Google.Apis.CloudMachineLearningEngine.v1.ProjectsResource.JobsResource.ListRequest.Parent
get

Required. The name of the project for which to list jobs.


The documentation for this class was generated from the following file: