Creates a Schedule.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800 seconds (30
minutes) and can be changed to a maximum value of 31536000 seconds (one year)
for long-running operations using the connector_params field. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params), refer to
Invoke a connector call.
Arguments
| Parameters | |
|---|---|
parent |
Required. The resource name of the Location to create the Schedule in. Format: |
region |
Required. Region of the HTTP endpoint. For example, if region is set to |
body |
Required. |
Raised exceptions
| Exceptions | |
|---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
OperationError |
If the long-running operation finished unsuccessfully. |
ResponseTypeError |
If the long-running operation returned a response of the wrong type. |
Response
If successful, the response contains an instance of GoogleCloudAiplatformV1beta1Schedule.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- create: call: googleapis.aiplatform.v1beta1.projects.locations.schedules.create args: parent: ... region: ... body: allowQueueing: ... createModelMonitoringJobRequest: modelMonitoringJob: displayName: ... modelMonitoringSpec: notificationSpec: emailConfig: userEmails: ... enableCloudLogging: ... notificationChannelConfigs: ... objectiveSpec: baselineDataset: batchPredictionOutput: batchPredictionJob: ... columnizedDataset: bigquerySource: query: ... tableUri: ... gcsSource: format: ... gcsUri: ... timestampField: ... vertexDataset: ... timeInterval: endTime: ... startTime: ... timeOffset: offset: ... window: ... vertexEndpointLogs: endpoints: ... explanationSpec: metadata: featureAttributionsSchemaUri: ... inputs: ... latentSpaceSource: ... outputs: ... parameters: examples: exampleGcsSource: dataFormat: ... gcsSource: uris: ... gcsSource: ... nearestNeighborSearchConfig: ... neighborCount: ... presets: modality: ... query: ... integratedGradientsAttribution: blurBaselineConfig: maxBlurSigma: ... smoothGradConfig: featureNoiseSigma: noiseSigma: ... noiseSigma: ... noisySampleCount: ... stepCount: ... outputIndices: ... sampledShapleyAttribution: pathCount: ... topK: ... xraiAttribution: blurBaselineConfig: ... smoothGradConfig: ... stepCount: ... tabularObjective: featureAttributionSpec: batchExplanationDedicatedResources: machineSpec: acceleratorCount: ... acceleratorType: ... machineType: ... tpuTopology: ... maxReplicaCount: ... startingReplicaCount: ... defaultAlertCondition: threshold: ... featureAlertConditions: ... features: ... featureDriftSpec: categoricalMetricType: ... defaultCategoricalAlertCondition: ... defaultNumericAlertCondition: ... featureAlertConditions: ... features: ... numericMetricType: ... predictionOutputDriftSpec: ... targetDataset: ... outputSpec: gcsBaseDirectory: outputUriPrefix: ... modelMonitoringJobId: ... parent: ... createNotebookExecutionJobRequest: notebookExecutionJob: customEnvironmentSpec: machineSpec: ... networkSpec: enableInternetAccess: ... network: ... subnetwork: ... persistentDiskSpec: diskSizeGb: ... diskType: ... dataformRepositorySource: commitSha: ... dataformRepositoryResourceName: ... directNotebookSource: content: ... displayName: ... executionTimeout: ... executionUser: ... gcsNotebookSource: generation: ... uri: ... gcsOutputUri: ... labels: ... notebookRuntimeTemplateResourceName: ... serviceAccount: ... notebookExecutionJobId: ... parent: ... createPipelineJobRequest: parent: ... pipelineJob: displayName: ... encryptionSpec: kmsKeyName: ... labels: ... network: ... pipelineSpec: ... preflightValidations: ... reservedIpRanges: ... runtimeConfig: failurePolicy: ... gcsOutputDirectory: ... inputArtifacts: ... parameterValues: ... parameters: ... serviceAccount: ... templateUri: ... pipelineJobId: ... cron: ... displayName: ... endTime: ... maxConcurrentRunCount: ... maxRunCount: ... name: ... startTime: ... result: createResult
JSON
[ { "create": { "call": "googleapis.aiplatform.v1beta1.projects.locations.schedules.create", "args": { "parent": "...", "region": "...", "body": { "allowQueueing": "...", "createModelMonitoringJobRequest": { "modelMonitoringJob": { "displayName": "...", "modelMonitoringSpec": { "notificationSpec": { "emailConfig": { "userEmails": "..." }, "enableCloudLogging": "...", "notificationChannelConfigs": "..." }, "objectiveSpec": { "baselineDataset": { "batchPredictionOutput": { "batchPredictionJob": "..." }, "columnizedDataset": { "bigquerySource": { "query": "...", "tableUri": "..." }, "gcsSource": { "format": "...", "gcsUri": "..." }, "timestampField": "...", "vertexDataset": "..." }, "timeInterval": { "endTime": "...", "startTime": "..." }, "timeOffset": { "offset": "...", "window": "..." }, "vertexEndpointLogs": { "endpoints": "..." } }, "explanationSpec": { "metadata": { "featureAttributionsSchemaUri": "...", "inputs": "...", "latentSpaceSource": "...", "outputs": "..." }, "parameters": { "examples": { "exampleGcsSource": { "dataFormat": "...", "gcsSource": { "uris": "..." } }, "gcsSource": "...", "nearestNeighborSearchConfig": "...", "neighborCount": "...", "presets": { "modality": "...", "query": "..." } }, "integratedGradientsAttribution": { "blurBaselineConfig": { "maxBlurSigma": "..." }, "smoothGradConfig": { "featureNoiseSigma": { "noiseSigma": "..." }, "noiseSigma": "...", "noisySampleCount": "..." }, "stepCount": "..." }, "outputIndices": "...", "sampledShapleyAttribution": { "pathCount": "..." }, "topK": "...", "xraiAttribution": { "blurBaselineConfig": "...", "smoothGradConfig": "...", "stepCount": "..." } } }, "tabularObjective": { "featureAttributionSpec": { "batchExplanationDedicatedResources": { "machineSpec": { "acceleratorCount": "...", "acceleratorType": "...", "machineType": "...", "tpuTopology": "..." }, "maxReplicaCount": "...", "startingReplicaCount": "..." }, "defaultAlertCondition": { "threshold": "..." }, "featureAlertConditions": "...", "features": "..." }, "featureDriftSpec": { "categoricalMetricType": "...", "defaultCategoricalAlertCondition": "...", "defaultNumericAlertCondition": "...", "featureAlertConditions": "...", "features": "...", "numericMetricType": "..." }, "predictionOutputDriftSpec": "..." }, "targetDataset": "..." }, "outputSpec": { "gcsBaseDirectory": { "outputUriPrefix": "..." } } } }, "modelMonitoringJobId": "...", "parent": "..." }, "createNotebookExecutionJobRequest": { "notebookExecutionJob": { "customEnvironmentSpec": { "machineSpec": "...", "networkSpec": { "enableInternetAccess": "...", "network": "...", "subnetwork": "..." }, "persistentDiskSpec": { "diskSizeGb": "...", "diskType": "..." } }, "dataformRepositorySource": { "commitSha": "...", "dataformRepositoryResourceName": "..." }, "directNotebookSource": { "content": "..." }, "displayName": "...", "executionTimeout": "...", "executionUser": "...", "gcsNotebookSource": { "generation": "...", "uri": "..." }, "gcsOutputUri": "...", "labels": "...", "notebookRuntimeTemplateResourceName": "...", "serviceAccount": "..." }, "notebookExecutionJobId": "...", "parent": "..." }, "createPipelineJobRequest": { "parent": "...", "pipelineJob": { "displayName": "...", "encryptionSpec": { "kmsKeyName": "..." }, "labels": "...", "network": "...", "pipelineSpec": "...", "preflightValidations": "...", "reservedIpRanges": "...", "runtimeConfig": { "failurePolicy": "...", "gcsOutputDirectory": "...", "inputArtifacts": "...", "parameterValues": "...", "parameters": "..." }, "serviceAccount": "...", "templateUri": "..." }, "pipelineJobId": "..." }, "cron": "...", "displayName": "...", "endTime": "...", "maxConcurrentRunCount": "...", "maxRunCount": "...", "name": "...", "startTime": "..." } }, "result": "createResult" } } ]