Package com.stripe.service.privacy

Class RedactionJobService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.privacy.RedactionJobService

public final class RedactionJobService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
RedactionJobService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
RedactionJob	cancel(String job)	You can cancel a redaction job when it’s in one of these statuses: ready, failed.
RedactionJob	cancel(String job, RequestOptions options)	You can cancel a redaction job when it’s in one of these statuses: ready, failed.
RedactionJob	cancel(String job, RedactionJobCancelParams params)	You can cancel a redaction job when it’s in one of these statuses: ready, failed.
RedactionJob	cancel(String job, RedactionJobCancelParams params, RequestOptions options)	You can cancel a redaction job when it’s in one of these statuses: ready, failed.
RedactionJob	create(RedactionJobCreateParams params)	Creates a redaction job.
RedactionJob	create(RedactionJobCreateParams params, RequestOptions options)	Creates a redaction job.
StripeCollection<RedactionJob>	list()	Returns a list of redaction jobs.
StripeCollection<RedactionJob>	list(RequestOptions options)	Returns a list of redaction jobs.
StripeCollection<RedactionJob>	list(RedactionJobListParams params)	Returns a list of redaction jobs.
StripeCollection<RedactionJob>	list(RedactionJobListParams params, RequestOptions options)	Returns a list of redaction jobs.
RedactionJob	retrieve(String job)	Retrieves the details of a previously created redaction job.
RedactionJob	retrieve(String job, RequestOptions options)	Retrieves the details of a previously created redaction job.
RedactionJob	retrieve(String job, RedactionJobRetrieveParams params)	Retrieves the details of a previously created redaction job.
RedactionJob	retrieve(String job, RedactionJobRetrieveParams params, RequestOptions options)	Retrieves the details of a previously created redaction job.
RedactionJob	run(String job)	Run a redaction job in a ready status.
RedactionJob	run(String job, RequestOptions options)	Run a redaction job in a ready status.
RedactionJob	run(String job, RedactionJobRunParams params)	Run a redaction job in a ready status.
RedactionJob	run(String job, RedactionJobRunParams params, RequestOptions options)	Run a redaction job in a ready status.
RedactionJob	update(String job)	Updates the properties of a redaction job without running or canceling the job.
RedactionJob	update(String job, RequestOptions options)	Updates the properties of a redaction job without running or canceling the job.
RedactionJob	update(String job, RedactionJobUpdateParams params)	Updates the properties of a redaction job without running or canceling the job.
RedactionJob	update(String job, RedactionJobUpdateParams params, RequestOptions options)	Updates the properties of a redaction job without running or canceling the job.
RedactionJob	validate(String job)	Validate a redaction job when it is in a failed status.
RedactionJob	validate(String job, RequestOptions options)	Validate a redaction job when it is in a failed status.
RedactionJob	validate(String job, RedactionJobValidateParams params)	Validate a redaction job when it is in a failed status.
RedactionJob	validate(String job, RedactionJobValidateParams params, RequestOptions options)	Validate a redaction job when it is in a failed status.
RedactionJobValidationErrorService	validationErrors()

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RedactionJobService

public RedactionJobService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<RedactionJob> list(RedactionJobListParams params)
                                    throws StripeException

Returns a list of redaction jobs.

Throws:

StripeException

list

public StripeCollection<RedactionJob> list(RequestOptions options)
                                    throws StripeException

Returns a list of redaction jobs.

Throws:

StripeException

list

public StripeCollection<RedactionJob> list()
                                    throws StripeException

Returns a list of redaction jobs.

Throws:

StripeException

list

public StripeCollection<RedactionJob> list(RedactionJobListParams params,
 RequestOptions options)
                                    throws StripeException

Returns a list of redaction jobs.

Throws:

StripeException

create

public RedactionJob create(RedactionJobCreateParams params)
                    throws StripeException

Creates a redaction job. When a job is created, it will start to validate.

Throws:

StripeException

create

public RedactionJob create(RedactionJobCreateParams params,
 RequestOptions options)
                    throws StripeException

Creates a redaction job. When a job is created, it will start to validate.

Throws:

StripeException

retrieve

public RedactionJob retrieve(String job,
 RedactionJobRetrieveParams params)
                      throws StripeException

Retrieves the details of a previously created redaction job.

Throws:

StripeException

retrieve

public RedactionJob retrieve(String job,
 RequestOptions options)
                      throws StripeException

Retrieves the details of a previously created redaction job.

Throws:

StripeException

retrieve

public RedactionJob retrieve(String job)
                      throws StripeException

Retrieves the details of a previously created redaction job.

Throws:

StripeException

retrieve

public RedactionJob retrieve(String job,
 RedactionJobRetrieveParams params,
 RequestOptions options)
                      throws StripeException

Retrieves the details of a previously created redaction job.

Throws:

StripeException

update

public RedactionJob update(String job,
 RedactionJobUpdateParams params)
                    throws StripeException

Updates the properties of a redaction job without running or canceling the job.

If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.

Throws:

StripeException

update

public RedactionJob update(String job,
 RequestOptions options)
                    throws StripeException

Updates the properties of a redaction job without running or canceling the job.

If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.

Throws:

StripeException

update

public RedactionJob update(String job)
                    throws StripeException

Updates the properties of a redaction job without running or canceling the job.

If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.

Throws:

StripeException

update

public RedactionJob update(String job,
 RedactionJobUpdateParams params,
 RequestOptions options)
                    throws StripeException

Updates the properties of a redaction job without running or canceling the job.

If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.

Throws:

StripeException

cancel

public RedactionJob cancel(String job,
 RedactionJobCancelParams params)
                    throws StripeException

You can cancel a redaction job when it’s in one of these statuses: ready, failed.

Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.

Throws:

StripeException

cancel

public RedactionJob cancel(String job,
 RequestOptions options)
                    throws StripeException

You can cancel a redaction job when it’s in one of these statuses: ready, failed.

Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.

Throws:

StripeException

cancel

public RedactionJob cancel(String job)
                    throws StripeException

You can cancel a redaction job when it’s in one of these statuses: ready, failed.

Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.

Throws:

StripeException

cancel

public RedactionJob cancel(String job,
 RedactionJobCancelParams params,
 RequestOptions options)
                    throws StripeException

You can cancel a redaction job when it’s in one of these statuses: ready, failed.

Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.

Throws:

StripeException

run

public RedactionJob run(String job,
 RedactionJobRunParams params)
                 throws StripeException

Run a redaction job in a ready status.

When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.

The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job’s validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.

Throws:

StripeException

run

public RedactionJob run(String job,
 RequestOptions options)
                 throws StripeException

Run a redaction job in a ready status.

When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.

The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job’s validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.

Throws:

StripeException

run

public RedactionJob run(String job)
                 throws StripeException

Run a redaction job in a ready status.

When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.

The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job’s validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.

Throws:

StripeException

run

public RedactionJob run(String job,
 RedactionJobRunParams params,
 RequestOptions options)
                 throws StripeException

Run a redaction job in a ready status.

When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.

The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job’s validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.

Throws:

StripeException

validate

public RedactionJob validate(String job,
 RedactionJobValidateParams params)
                      throws StripeException

Validate a redaction job when it is in a failed status.

When a job is created, it automatically begins to validate on the configured objects’ eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job’s validation_behavior is changed.

The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.

Throws:

StripeException

validate

public RedactionJob validate(String job,
 RequestOptions options)
                      throws StripeException

Validate a redaction job when it is in a failed status.

When a job is created, it automatically begins to validate on the configured objects’ eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job’s validation_behavior is changed.

The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.

Throws:

StripeException

validate

public RedactionJob validate(String job)
                      throws StripeException

Validate a redaction job when it is in a failed status.

When a job is created, it automatically begins to validate on the configured objects’ eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job’s validation_behavior is changed.

The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.

Throws:

StripeException

validate

public RedactionJob validate(String job,
 RedactionJobValidateParams params,
 RequestOptions options)
                      throws StripeException

Validate a redaction job when it is in a failed status.

When a job is created, it automatically begins to validate on the configured objects’ eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job’s validation_behavior is changed.

The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.

Throws:

StripeException

validationErrors

public RedactionJobValidationErrorService validationErrors()