def schedules_update(schedule_name, new_name, data, format_, **kwargs):
"""Update a request schedule."""
project_name = get_current_project(error=True)
client = init_client()
if data is not None:
schedule = client.request_schedules_get(project_name=project_name,
schedule_name=schedule_name)
obj = get_schedule_object(client, project_name, schedule.object_type,
schedule.object_name)
if obj.input_type == STRUCTURED_TYPE:
data = parse_json(data)
new_schedule = api.ScheduleUpdate(
name=new_name,
request_data=data,
**{k: v
for k, v in kwargs.items() if v is not None})
response = client.request_schedules_update(project_name=project_name,
schedule_name=schedule_name,
data=new_schedule)
client.api_client.close()
print_item(response, LIST_ITEMS, rename=RENAME_COLUMNS, fmt=format_)
def schedules_create(schedule_name, object_type, object_name, object_version,
data, format_, **kwargs):
"""
Create a new request schedule.
- For express mode deployments, direct requests will be made
- For batch mode deployments, batch requests will be made
- For pipelines, batch requests will be made
"""
project_name = get_current_project(error=True)
client = init_client()
obj = get_schedule_object(client, project_name, object_type, object_name)
if obj.input_type == STRUCTURED_TYPE:
data = parse_json(data)
schedule = api.ScheduleCreate(name=schedule_name,
object_type=object_type,
object_name=object_name,
version=object_version,
request_data=data,
**kwargs)
response = client.request_schedules_create(project_name=project_name,
data=schedule)
client.api_client.close()
print_item(response, LIST_ITEMS, rename=RENAME_COLUMNS, fmt=format_)
def deprecated_batch_requests_create(deployment_name, version_name, data, timeout, format_):
"""
[DEPRECATED] Create a deployment batch request and retrieve request IDs to collect the results later.
Deployment requests are only stored for deployment versions with `request_retention_mode` 'full' or 'metadata'.
Use the option `timeout` to specify the timeout of the request. The minimum value is 10 seconds. The maximum value
is 345600 (96 hours). The default value is 14400 (4 hours).
Use the version option to make a batch request to a specific deployment version:
`ubiops deployments batch_requests create <my-deployment> -v <my-version> --data <input>`
If not specified, a batch request is made to the default version:
`ubiops deployments batch_requests create <my-deployment> --data <input>`
Multiple data inputs can be specified at ones by using the '--data' options multiple times:
`ubiops deployments batch_requests create <my-deployment> --data <input-1> --data <input-2> --data <input-3>`
For structured input, specify each data input as JSON formatted string. For example:
`ubiops deployments batch_requests create <my-deployment> --data "{\\"param1\\": 1, \\"param2\\": \\"two\\"}"`
"""
if format_ != 'json':
click.secho(
"Deprecation warning: 'batch_requests create' is deprecated, use 'requests create --batch' instead",
fg='red'
)
data = list(data)
project_name = get_current_project(error=True)
client = init_client()
deployment = client.deployments_get(project_name=project_name, deployment_name=deployment_name)
if deployment.input_type == STRUCTURED_TYPE:
input_data = []
for d in data:
input_data.append(parse_json(d))
else:
input_data = data
if version_name is not None:
response = client.batch_deployment_version_requests_create(
project_name=project_name, deployment_name=deployment_name, version=version_name, data=input_data,
timeout=timeout
)
else:
response = client.batch_deployment_requests_create(
project_name=project_name, deployment_name=deployment_name, data=input_data, timeout=timeout
)
client.api_client.close()
if format_ == 'reference':
click.echo(format_requests_reference(response))
elif format_ == 'oneline':
click.echo(format_requests_oneline(response))
elif format_ == 'json':
click.echo(format_json(response))
else:
click.echo(format_requests_reference(response))
def deprecated_pipelines_request(pipeline_name, version_name, data,
pipeline_timeout, deployment_timeout,
format_):
"""
[DEPRECATED] Create a pipeline request and retrieve the result.
Use the version option to make a request to a specific pipeline version:
`ubiops pipelines request <my-deployment> -v <my-version> --data <input>`
If not specified, a request is made to the default version:
`ubiops pipelines request <my-deployment> --data <input>`
For structured input, specify the data as JSON formatted string. For example:
`ubiops pipelines request <my-deployment> --data "{\\"param1\\": 1, \\"param2\\": \\"two\\"}"`
"""
if format_ != 'json':
click.secho(
"Deprecation warning: 'request' is deprecated, use 'requests create' instead",
fg='red')
project_name = get_current_project(error=True)
client = init_client()
pipeline = client.pipelines_get(project_name=project_name,
pipeline_name=pipeline_name)
if pipeline.input_type == STRUCTURED_TYPE:
data = parse_json(data)
if version_name is not None:
response = client.pipeline_version_requests_create(
project_name=project_name,
pipeline_name=pipeline_name,
version=version_name,
data=data,
pipeline_timeout=pipeline_timeout,
deployment_timeout=deployment_timeout)
else:
response = client.pipeline_requests_create(
project_name=project_name,
pipeline_name=pipeline_name,
data=data,
pipeline_timeout=pipeline_timeout,
deployment_timeout=deployment_timeout)
client.api_client.close()
if format_ == 'reference':
click.echo(format_pipeline_requests_reference([response]))
elif format_ == 'oneline':
click.echo(format_pipeline_requests_oneline([response]))
elif format_ == 'json':
click.echo(format_json(response))
else:
click.echo(format_pipeline_requests_reference([response]))
def requests_create(deployment_name, version_name, batch, data, json_file, timeout, format_):
"""
Create a deployment request and retrieve request IDs to collect the results later.
Use the option `timeout` to specify the timeout of the request. The minimum value is 10 seconds. The maximum value
is 3600 (1 hour) for express deployments and 345600 (96 hours) for batch deployments. The default value is 300
(5 minutes) for express deployments and 14400 (4 hours) for batch deployments.
Use the version option to make a request to a specific deployment version:
`ubiops deployments requests create <my-deployment> -v <my-version> --data <input>`
If not specified, a request is made to the default version:
`ubiops deployments requests create <my-deployment> --data <input>`
Use `--batch` to make an asynchronous batch request:
`ubiops deployments requests create <my-deployment> --batch --data <input>`
Multiple data inputs can be specified at ones and send as batch by using the '--data' options multiple times:
`ubiops deployments requests create <my-deployment> --batch --data <input-1> --data <input-2> --data <input-3>`
For structured input, specify data input as JSON formatted string. For example:
`ubiops deployments requests create <my-deployment> --data "{\\"param1\\": 1, \\"param2\\": \\"two\\"}"`
"""
data = list(data)
project_name = get_current_project(error=True)
client = init_client()
deployment = client.deployments_get(project_name=project_name, deployment_name=deployment_name)
if json_file and data:
raise Exception("Specify data either using the <data> or <json_file> option, not both")
if json_file:
input_data = read_json(json_file)
if not isinstance(input_data, list):
input_data = [input_data]
elif data:
if deployment.input_type == STRUCTURED_TYPE:
input_data = []
for d in data:
input_data.append(parse_json(d))
else:
input_data = data
else:
raise Exception("Missing option <data> or <json_file>")
if version_name is not None:
if batch:
response = client.batch_deployment_version_requests_create(
project_name=project_name, deployment_name=deployment_name,
version=version_name, data=input_data, timeout=timeout
)
else:
response = [client.deployment_version_requests_create(
project_name=project_name, deployment_name=deployment_name,
version=version_name, data=input_data, timeout=timeout
)]
else:
if batch:
response = client.batch_deployment_requests_create(
project_name=project_name, deployment_name=deployment_name, data=input_data, timeout=timeout
)
else:
response = [client.deployment_requests_create(
project_name=project_name, deployment_name=deployment_name, data=input_data, timeout=timeout
)]
client.api_client.close()
if format_ == 'reference':
click.echo(format_requests_reference(response))
elif format_ == 'oneline':
click.echo(format_requests_oneline(response))
elif format_ == 'json':
click.echo(format_json(response))
else:
click.echo(format_requests_reference(response))
def requests_create(pipeline_name, version_name, batch, timeout,
deployment_timeout, data, json_file, format_):
"""
Create a pipeline request. Use `--batch` to create a batch (asynchronous) request.
It's only possible to create a direct (synchronous) request to pipelines without 'batch' mode deployments. In
contrast, batch (asynchronous) requests can be made to any pipeline, independent on the deployment modes.
Pipeline requests are only stored for pipeline versions with `request_retention_mode` 'full' or 'metadata'.
Use the option `timeout` to specify the timeout of the pipeline request. The minimum value is 10 seconds.
The maximum value is 7200 (2 hours) for direct requests and 345600 (96 hours) for batch requests. The default value
is 3600 (1 hour) for direct requests and 14400 (4 hours) for batch requests.
Use the version option to make a request to a specific pipeline version:
`ubiops pipelines requests create <my-pipeline> -v <my-version> --data <input>`
If not specified, a request is made to the default version:
`ubiops pipelines requests create <my-pipeline> --data <input>`
Use `--batch` to make an asynchronous batch request:
`ubiops pipelines requests create <my-pipeline> --batch --data <input>`
Multiple data inputs can be specified at ones and send as batch by using the '--data' options multiple times:
`ubiops pipelines requests create <my-pipeline> --batch --data <input-1> --data <input-2> --data <input-3>`
For structured input, specify each data input as JSON formatted string. For example:
`ubiops pipelines requests create <my-pipeline> --data "{\\"param1\\": 1, \\"param2\\": \\"two\\"}"`
"""
data = list(data)
project_name = get_current_project(error=True)
client = init_client()
pipeline = client.pipelines_get(project_name=project_name,
pipeline_name=pipeline_name)
if batch and deployment_timeout is not None:
raise Exception(
"It's not possible to pass a deployment timeout for a batch pipeline request"
)
if json_file and data:
raise Exception(
"Specify data either using the <data> or <json_file> option, not both"
)
if json_file:
input_data = read_json(json_file)
if not isinstance(input_data, list):
input_data = [input_data]
elif data:
if pipeline.input_type == STRUCTURED_TYPE:
input_data = []
for d in data:
input_data.append(parse_json(d))
else:
input_data = data
else:
raise Exception("Missing option <data> or <json_file>")
if version_name is not None:
if batch:
response = client.batch_pipeline_version_requests_create(
project_name=project_name,
pipeline_name=pipeline_name,
version=version_name,
data=input_data,
timeout=timeout)
else:
response = [
client.pipeline_version_requests_create(
project_name=project_name,
pipeline_name=pipeline_name,
version=version_name,
data=input_data,
pipeline_timeout=timeout,
deployment_timeout=deployment_timeout)
]
else:
if batch:
response = client.batch_pipeline_requests_create(
project_name=project_name,
pipeline_name=pipeline_name,
data=input_data,
timeout=timeout)
else:
response = [
client.pipeline_requests_create(
project_name=project_name,
pipeline_name=pipeline_name,
data=input_data,
pipeline_timeout=timeout,
deployment_timeout=deployment_timeout)
]
client.api_client.close()
if format_ == 'reference':
click.echo(format_pipeline_requests_reference(response))
elif format_ == 'oneline':
click.echo(format_pipeline_requests_oneline(response))
elif format_ == 'json':
click.echo(format_json(response))
else:
click.echo(format_pipeline_requests_reference(response))