object_bucket_replication_triggers

Creates, updates, deletes, gets or lists an object_bucket_replication_triggers resource.

Overview

Name	object_bucket_replication_triggers
Type	Resource
Id	ovh.public_cloud_storage.object_bucket_replication_triggers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the job
completed	integer	Number of successfully replicated objects
created_at	string (date-time)	Job creation date (wire: createdAt)
failed	integer	Number of objects that failed to replicate
status	string	Job status (ACTIVE, COMPLETED, CREATED, FAILED, PREPARING)
stuck	integer	Number of stuck objects
total	integer	Total number of objects to replicate

list

A batch replication job applying a bucket's replication configuration to its existing objects

Name	Datatype	Description
id	string	Unique identifier of the job
completed	integer	Number of successfully replicated objects
created_at	string (date-time)	Job creation date (wire: createdAt)
failed	integer	Number of objects that failed to replicate
status	string	Job status (ACTIVE, COMPLETED, CREATED, FAILED, PREPARING)
stuck	integer	Number of stuck objects
total	integer	Total number of objects to replicate

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	bucket_name, id, project_id		Returns the progress of a batch replication job: total, completed, failed and stuck objects. (Alpha version)
list	select	bucket_name, project_id	x_pagination_cursor, x_pagination_size	Returns the batch replication jobs of the bucket and their progress. (Alpha version)
create	insert	bucket_name, project_id		Applies the current replication rules to the objects already in the bucket. (Alpha version)

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
bucket_name	string	Bucket name (wire: bucketName)
id	string	Id
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the progress of a batch replication job: total, completed, failed and stuck objects. (Alpha version)

SELECT
id,
completed,
created_at,
failed,
status,
stuck,
total
FROM ovh.public_cloud_storage.object_bucket_replication_triggers
WHERE bucket_name = '{{ bucket_name }}' -- required
AND id = '{{ id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the batch replication jobs of the bucket and their progress. (Alpha version)

SELECT
id,
completed,
created_at,
failed,
status,
stuck,
total
FROM ovh.public_cloud_storage.object_bucket_replication_triggers
WHERE bucket_name = '{{ bucket_name }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Applies the current replication rules to the objects already in the bucket. (Alpha version)

INSERT INTO ovh.public_cloud_storage.object_bucket_replication_triggers (
bucket_name,
project_id
)
SELECT 
'{{ bucket_name }}',
'{{ project_id }}'
RETURNING
id,
completed,
created_at,
failed,
status,
stuck,
total
;

Manifest

# Description fields are for documentation purposes
- name: object_bucket_replication_triggers
props:
  - name: bucket_name
    value: "{{ bucket_name }}"
    description: Required parameter for the object_bucket_replication_triggers resource.
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the object_bucket_replication_triggers resource.