diff --git a/google-api-grpc/grpc-google-cloud-dlp-v2/src/main/java/com/google/privacy/dlp/v2/DlpServiceGrpc.java b/google-api-grpc/grpc-google-cloud-dlp-v2/src/main/java/com/google/privacy/dlp/v2/DlpServiceGrpc.java index d291ae3451ab..563aa1ce9b87 100644 --- a/google-api-grpc/grpc-google-cloud-dlp-v2/src/main/java/com/google/privacy/dlp/v2/DlpServiceGrpc.java +++ b/google-api-grpc/grpc-google-cloud-dlp-v2/src/main/java/com/google/privacy/dlp/v2/DlpServiceGrpc.java @@ -23,6 +23,8 @@ * blocks or images. * The service also includes methods for sensitive data redaction and * scheduling of data scans on Google Cloud Platform based data sets. + * To learn more about concepts and find how-to guides see + * https://cloud.google.com/dlp/docs/. * */ @javax.annotation.Generated( @@ -992,6 +994,8 @@ public static DlpServiceFutureStub newFutureStub( * blocks or images. * The service also includes methods for sensitive data redaction and * scheduling of data scans on Google Cloud Platform based data sets. + * To learn more about concepts and find how-to guides see + * https://cloud.google.com/dlp/docs/. * */ public static abstract class DlpServiceImplBase implements io.grpc.BindableService { @@ -1000,8 +1004,11 @@ public static abstract class DlpServiceImplBase implements io.grpc.BindableServi *
* Finds potentially sensitive info in content. * This method has limits on input size, processing time, and output size. - * [How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for - * images](/dlp/docs/inspecting-images) + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. + * For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images + * and https://cloud.google.com/dlp/docs/inspecting-text, **/ public void inspectContent(com.google.privacy.dlp.v2.InspectContentRequest request, @@ -1013,7 +1020,11 @@ public void inspectContent(com.google.privacy.dlp.v2.InspectContentRequest reque *
* Redacts potentially sensitive info from an image. * This method has limits on input size, processing time, and output size. - * [How-to guide](/dlp/docs/redacting-sensitive-data-images) + * See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to + * learn more. + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public void redactImage(com.google.privacy.dlp.v2.RedactImageRequest request, @@ -1025,7 +1036,11 @@ public void redactImage(com.google.privacy.dlp.v2.RedactImageRequest request, *
* De-identifies potentially sensitive info from a ContentItem. * This method has limits on input size and output size. - * [How-to guide](/dlp/docs/deidentify-sensitive-data) + * See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to + * learn more. + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public void deidentifyContent(com.google.privacy.dlp.v2.DeidentifyContentRequest request, @@ -1036,6 +1051,9 @@ public void deidentifyContent(com.google.privacy.dlp.v2.DeidentifyContentRequest /** *
* Re-identifies content that has been de-identified. + * See + * https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example + * to learn more. **/ public void reidentifyContent(com.google.privacy.dlp.v2.ReidentifyContentRequest request, @@ -1046,8 +1064,8 @@ public void reidentifyContent(com.google.privacy.dlp.v2.ReidentifyContentRequest /** *
* Returns a list of the sensitive information types that the DLP API - * supports. For more information, see [Listing supported predefined - * infoTypes](/dlp/docs/listing-infotypes). + * supports. See https://cloud.google.com/dlp/docs/infotypes-reference to + * learn more. **/ public void listInfoTypes(com.google.privacy.dlp.v2.ListInfoTypesRequest request, @@ -1059,6 +1077,7 @@ public void listInfoTypes(com.google.privacy.dlp.v2.ListInfoTypesRequest request *
* Creates an InspectTemplate for re-using frequently used configuration * for inspecting content, images, and storage. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void createInspectTemplate(com.google.privacy.dlp.v2.CreateInspectTemplateRequest request, @@ -1069,6 +1088,7 @@ public void createInspectTemplate(com.google.privacy.dlp.v2.CreateInspectTemplat /** *
* Updates the InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void updateInspectTemplate(com.google.privacy.dlp.v2.UpdateInspectTemplateRequest request, @@ -1079,6 +1099,7 @@ public void updateInspectTemplate(com.google.privacy.dlp.v2.UpdateInspectTemplat /** *
* Gets an InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void getInspectTemplate(com.google.privacy.dlp.v2.GetInspectTemplateRequest request, @@ -1089,6 +1110,7 @@ public void getInspectTemplate(com.google.privacy.dlp.v2.GetInspectTemplateReque /** *
* Lists InspectTemplates. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void listInspectTemplates(com.google.privacy.dlp.v2.ListInspectTemplatesRequest request, @@ -1099,6 +1121,7 @@ public void listInspectTemplates(com.google.privacy.dlp.v2.ListInspectTemplatesR /** *
* Deletes an InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void deleteInspectTemplate(com.google.privacy.dlp.v2.DeleteInspectTemplateRequest request, @@ -1110,6 +1133,8 @@ public void deleteInspectTemplate(com.google.privacy.dlp.v2.DeleteInspectTemplat *
* Creates a DeidentifyTemplate for re-using frequently used configuration * for de-identifying content, images, and storage. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void createDeidentifyTemplate(com.google.privacy.dlp.v2.CreateDeidentifyTemplateRequest request, @@ -1120,6 +1145,8 @@ public void createDeidentifyTemplate(com.google.privacy.dlp.v2.CreateDeidentifyT /** *
* Updates the DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void updateDeidentifyTemplate(com.google.privacy.dlp.v2.UpdateDeidentifyTemplateRequest request, @@ -1130,6 +1157,8 @@ public void updateDeidentifyTemplate(com.google.privacy.dlp.v2.UpdateDeidentifyT /** *
* Gets a DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void getDeidentifyTemplate(com.google.privacy.dlp.v2.GetDeidentifyTemplateRequest request, @@ -1140,6 +1169,8 @@ public void getDeidentifyTemplate(com.google.privacy.dlp.v2.GetDeidentifyTemplat /** *
* Lists DeidentifyTemplates. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void listDeidentifyTemplates(com.google.privacy.dlp.v2.ListDeidentifyTemplatesRequest request, @@ -1150,6 +1181,8 @@ public void listDeidentifyTemplates(com.google.privacy.dlp.v2.ListDeidentifyTemp /** *
* Deletes a DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void deleteDeidentifyTemplate(com.google.privacy.dlp.v2.DeleteDeidentifyTemplateRequest request, @@ -1161,6 +1194,7 @@ public void deleteDeidentifyTemplate(com.google.privacy.dlp.v2.DeleteDeidentifyT *
* Creates a job trigger to run DLP actions such as scanning storage for * sensitive information on a set schedule. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void createJobTrigger(com.google.privacy.dlp.v2.CreateJobTriggerRequest request, @@ -1171,6 +1205,7 @@ public void createJobTrigger(com.google.privacy.dlp.v2.CreateJobTriggerRequest r /** *
* Updates a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void updateJobTrigger(com.google.privacy.dlp.v2.UpdateJobTriggerRequest request, @@ -1181,6 +1216,7 @@ public void updateJobTrigger(com.google.privacy.dlp.v2.UpdateJobTriggerRequest r /** *
* Gets a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void getJobTrigger(com.google.privacy.dlp.v2.GetJobTriggerRequest request, @@ -1191,6 +1227,7 @@ public void getJobTrigger(com.google.privacy.dlp.v2.GetJobTriggerRequest request /** *
* Lists job triggers. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void listJobTriggers(com.google.privacy.dlp.v2.ListJobTriggersRequest request, @@ -1201,6 +1238,7 @@ public void listJobTriggers(com.google.privacy.dlp.v2.ListJobTriggersRequest req /** *
* Deletes a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void deleteJobTrigger(com.google.privacy.dlp.v2.DeleteJobTriggerRequest request, @@ -1211,7 +1249,11 @@ public void deleteJobTrigger(com.google.privacy.dlp.v2.DeleteJobTriggerRequest r /** *
* Creates a new job to inspect storage or calculate risk metrics. - * [How-to guide](/dlp/docs/compute-risk-analysis). + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public void createDlpJob(com.google.privacy.dlp.v2.CreateDlpJobRequest request, @@ -1222,6 +1264,8 @@ public void createDlpJob(com.google.privacy.dlp.v2.CreateDlpJobRequest request, /** *
* Lists DlpJobs that match the specified filter in the request. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. **/ public void listDlpJobs(com.google.privacy.dlp.v2.ListDlpJobsRequest request, @@ -1232,6 +1276,8 @@ public void listDlpJobs(com.google.privacy.dlp.v2.ListDlpJobsRequest request, /** *
* Gets the latest state of a long-running DlpJob. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. **/ public void getDlpJob(com.google.privacy.dlp.v2.GetDlpJobRequest request, @@ -1244,6 +1290,8 @@ public void getDlpJob(com.google.privacy.dlp.v2.GetDlpJobRequest request, * Deletes a long-running DlpJob. This method indicates that the client is * no longer interested in the DlpJob result. The job will be cancelled if * possible. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * */ public void deleteDlpJob(com.google.privacy.dlp.v2.DeleteDlpJobRequest request, @@ -1256,6 +1304,8 @@ public void deleteDlpJob(com.google.privacy.dlp.v2.DeleteDlpJobRequest request, * Starts asynchronous cancellation on a long-running DlpJob. The server * makes a best effort to cancel the DlpJob, but success is not * guaranteed. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * */ public void cancelDlpJob(com.google.privacy.dlp.v2.CancelDlpJobRequest request, @@ -1452,6 +1502,8 @@ public void cancelDlpJob(com.google.privacy.dlp.v2.CancelDlpJobRequest request, * blocks or images. * The service also includes methods for sensitive data redaction and * scheduling of data scans on Google Cloud Platform based data sets. + * To learn more about concepts and find how-to guides see + * https://cloud.google.com/dlp/docs/. * */ public static final class DlpServiceStub extends io.grpc.stub.AbstractStub
* Finds potentially sensitive info in content. * This method has limits on input size, processing time, and output size. - * [How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for - * images](/dlp/docs/inspecting-images) + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. + * For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images + * and https://cloud.google.com/dlp/docs/inspecting-text, **/ public void inspectContent(com.google.privacy.dlp.v2.InspectContentRequest request, @@ -1488,7 +1543,11 @@ public void inspectContent(com.google.privacy.dlp.v2.InspectContentRequest reque *
* Redacts potentially sensitive info from an image. * This method has limits on input size, processing time, and output size. - * [How-to guide](/dlp/docs/redacting-sensitive-data-images) + * See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to + * learn more. + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public void redactImage(com.google.privacy.dlp.v2.RedactImageRequest request, @@ -1501,7 +1560,11 @@ public void redactImage(com.google.privacy.dlp.v2.RedactImageRequest request, *
* De-identifies potentially sensitive info from a ContentItem. * This method has limits on input size and output size. - * [How-to guide](/dlp/docs/deidentify-sensitive-data) + * See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to + * learn more. + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public void deidentifyContent(com.google.privacy.dlp.v2.DeidentifyContentRequest request, @@ -1513,6 +1576,9 @@ public void deidentifyContent(com.google.privacy.dlp.v2.DeidentifyContentRequest /** *
* Re-identifies content that has been de-identified. + * See + * https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example + * to learn more. **/ public void reidentifyContent(com.google.privacy.dlp.v2.ReidentifyContentRequest request, @@ -1524,8 +1590,8 @@ public void reidentifyContent(com.google.privacy.dlp.v2.ReidentifyContentRequest /** *
* Returns a list of the sensitive information types that the DLP API - * supports. For more information, see [Listing supported predefined - * infoTypes](/dlp/docs/listing-infotypes). + * supports. See https://cloud.google.com/dlp/docs/infotypes-reference to + * learn more. **/ public void listInfoTypes(com.google.privacy.dlp.v2.ListInfoTypesRequest request, @@ -1538,6 +1604,7 @@ public void listInfoTypes(com.google.privacy.dlp.v2.ListInfoTypesRequest request *
* Creates an InspectTemplate for re-using frequently used configuration * for inspecting content, images, and storage. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void createInspectTemplate(com.google.privacy.dlp.v2.CreateInspectTemplateRequest request, @@ -1549,6 +1616,7 @@ public void createInspectTemplate(com.google.privacy.dlp.v2.CreateInspectTemplat /** *
* Updates the InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void updateInspectTemplate(com.google.privacy.dlp.v2.UpdateInspectTemplateRequest request, @@ -1560,6 +1628,7 @@ public void updateInspectTemplate(com.google.privacy.dlp.v2.UpdateInspectTemplat /** *
* Gets an InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void getInspectTemplate(com.google.privacy.dlp.v2.GetInspectTemplateRequest request, @@ -1571,6 +1640,7 @@ public void getInspectTemplate(com.google.privacy.dlp.v2.GetInspectTemplateReque /** *
* Lists InspectTemplates. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void listInspectTemplates(com.google.privacy.dlp.v2.ListInspectTemplatesRequest request, @@ -1582,6 +1652,7 @@ public void listInspectTemplates(com.google.privacy.dlp.v2.ListInspectTemplatesR /** *
* Deletes an InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public void deleteInspectTemplate(com.google.privacy.dlp.v2.DeleteInspectTemplateRequest request, @@ -1594,6 +1665,8 @@ public void deleteInspectTemplate(com.google.privacy.dlp.v2.DeleteInspectTemplat *
* Creates a DeidentifyTemplate for re-using frequently used configuration * for de-identifying content, images, and storage. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void createDeidentifyTemplate(com.google.privacy.dlp.v2.CreateDeidentifyTemplateRequest request, @@ -1605,6 +1678,8 @@ public void createDeidentifyTemplate(com.google.privacy.dlp.v2.CreateDeidentifyT /** *
* Updates the DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void updateDeidentifyTemplate(com.google.privacy.dlp.v2.UpdateDeidentifyTemplateRequest request, @@ -1616,6 +1691,8 @@ public void updateDeidentifyTemplate(com.google.privacy.dlp.v2.UpdateDeidentifyT /** *
* Gets a DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void getDeidentifyTemplate(com.google.privacy.dlp.v2.GetDeidentifyTemplateRequest request, @@ -1627,6 +1704,8 @@ public void getDeidentifyTemplate(com.google.privacy.dlp.v2.GetDeidentifyTemplat /** *
* Lists DeidentifyTemplates. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void listDeidentifyTemplates(com.google.privacy.dlp.v2.ListDeidentifyTemplatesRequest request, @@ -1638,6 +1717,8 @@ public void listDeidentifyTemplates(com.google.privacy.dlp.v2.ListDeidentifyTemp /** *
* Deletes a DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public void deleteDeidentifyTemplate(com.google.privacy.dlp.v2.DeleteDeidentifyTemplateRequest request, @@ -1650,6 +1731,7 @@ public void deleteDeidentifyTemplate(com.google.privacy.dlp.v2.DeleteDeidentifyT *
* Creates a job trigger to run DLP actions such as scanning storage for * sensitive information on a set schedule. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void createJobTrigger(com.google.privacy.dlp.v2.CreateJobTriggerRequest request, @@ -1661,6 +1743,7 @@ public void createJobTrigger(com.google.privacy.dlp.v2.CreateJobTriggerRequest r /** *
* Updates a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void updateJobTrigger(com.google.privacy.dlp.v2.UpdateJobTriggerRequest request, @@ -1672,6 +1755,7 @@ public void updateJobTrigger(com.google.privacy.dlp.v2.UpdateJobTriggerRequest r /** *
* Gets a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void getJobTrigger(com.google.privacy.dlp.v2.GetJobTriggerRequest request, @@ -1683,6 +1767,7 @@ public void getJobTrigger(com.google.privacy.dlp.v2.GetJobTriggerRequest request /** *
* Lists job triggers. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void listJobTriggers(com.google.privacy.dlp.v2.ListJobTriggersRequest request, @@ -1694,6 +1779,7 @@ public void listJobTriggers(com.google.privacy.dlp.v2.ListJobTriggersRequest req /** *
* Deletes a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public void deleteJobTrigger(com.google.privacy.dlp.v2.DeleteJobTriggerRequest request, @@ -1705,7 +1791,11 @@ public void deleteJobTrigger(com.google.privacy.dlp.v2.DeleteJobTriggerRequest r /** *
* Creates a new job to inspect storage or calculate risk metrics. - * [How-to guide](/dlp/docs/compute-risk-analysis). + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public void createDlpJob(com.google.privacy.dlp.v2.CreateDlpJobRequest request, @@ -1717,6 +1807,8 @@ public void createDlpJob(com.google.privacy.dlp.v2.CreateDlpJobRequest request, /** *
* Lists DlpJobs that match the specified filter in the request. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. **/ public void listDlpJobs(com.google.privacy.dlp.v2.ListDlpJobsRequest request, @@ -1728,6 +1820,8 @@ public void listDlpJobs(com.google.privacy.dlp.v2.ListDlpJobsRequest request, /** *
* Gets the latest state of a long-running DlpJob. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. **/ public void getDlpJob(com.google.privacy.dlp.v2.GetDlpJobRequest request, @@ -1741,6 +1835,8 @@ public void getDlpJob(com.google.privacy.dlp.v2.GetDlpJobRequest request, * Deletes a long-running DlpJob. This method indicates that the client is * no longer interested in the DlpJob result. The job will be cancelled if * possible. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * */ public void deleteDlpJob(com.google.privacy.dlp.v2.DeleteDlpJobRequest request, @@ -1754,6 +1850,8 @@ public void deleteDlpJob(com.google.privacy.dlp.v2.DeleteDlpJobRequest request, * Starts asynchronous cancellation on a long-running DlpJob. The server * makes a best effort to cancel the DlpJob, but success is not * guaranteed. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * */ public void cancelDlpJob(com.google.privacy.dlp.v2.CancelDlpJobRequest request, @@ -1771,6 +1869,8 @@ public void cancelDlpJob(com.google.privacy.dlp.v2.CancelDlpJobRequest request, * blocks or images. * The service also includes methods for sensitive data redaction and * scheduling of data scans on Google Cloud Platform based data sets. + * To learn more about concepts and find how-to guides see + * https://cloud.google.com/dlp/docs/. * */ public static final class DlpServiceBlockingStub extends io.grpc.stub.AbstractStub
* Finds potentially sensitive info in content. * This method has limits on input size, processing time, and output size. - * [How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for - * images](/dlp/docs/inspecting-images) + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. + * For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images + * and https://cloud.google.com/dlp/docs/inspecting-text, **/ public com.google.privacy.dlp.v2.InspectContentResponse inspectContent(com.google.privacy.dlp.v2.InspectContentRequest request) { @@ -1806,7 +1909,11 @@ public com.google.privacy.dlp.v2.InspectContentResponse inspectContent(com.googl *
* Redacts potentially sensitive info from an image. * This method has limits on input size, processing time, and output size. - * [How-to guide](/dlp/docs/redacting-sensitive-data-images) + * See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to + * learn more. + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public com.google.privacy.dlp.v2.RedactImageResponse redactImage(com.google.privacy.dlp.v2.RedactImageRequest request) { @@ -1818,7 +1925,11 @@ public com.google.privacy.dlp.v2.RedactImageResponse redactImage(com.google.priv *
* De-identifies potentially sensitive info from a ContentItem. * This method has limits on input size and output size. - * [How-to guide](/dlp/docs/deidentify-sensitive-data) + * See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to + * learn more. + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public com.google.privacy.dlp.v2.DeidentifyContentResponse deidentifyContent(com.google.privacy.dlp.v2.DeidentifyContentRequest request) { @@ -1829,6 +1940,9 @@ public com.google.privacy.dlp.v2.DeidentifyContentResponse deidentifyContent(com /** *
* Re-identifies content that has been de-identified. + * See + * https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example + * to learn more. **/ public com.google.privacy.dlp.v2.ReidentifyContentResponse reidentifyContent(com.google.privacy.dlp.v2.ReidentifyContentRequest request) { @@ -1839,8 +1953,8 @@ public com.google.privacy.dlp.v2.ReidentifyContentResponse reidentifyContent(com /** *
* Returns a list of the sensitive information types that the DLP API - * supports. For more information, see [Listing supported predefined - * infoTypes](/dlp/docs/listing-infotypes). + * supports. See https://cloud.google.com/dlp/docs/infotypes-reference to + * learn more. **/ public com.google.privacy.dlp.v2.ListInfoTypesResponse listInfoTypes(com.google.privacy.dlp.v2.ListInfoTypesRequest request) { @@ -1852,6 +1966,7 @@ public com.google.privacy.dlp.v2.ListInfoTypesResponse listInfoTypes(com.google. *
* Creates an InspectTemplate for re-using frequently used configuration * for inspecting content, images, and storage. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public com.google.privacy.dlp.v2.InspectTemplate createInspectTemplate(com.google.privacy.dlp.v2.CreateInspectTemplateRequest request) { @@ -1862,6 +1977,7 @@ public com.google.privacy.dlp.v2.InspectTemplate createInspectTemplate(com.googl /** *
* Updates the InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public com.google.privacy.dlp.v2.InspectTemplate updateInspectTemplate(com.google.privacy.dlp.v2.UpdateInspectTemplateRequest request) { @@ -1872,6 +1988,7 @@ public com.google.privacy.dlp.v2.InspectTemplate updateInspectTemplate(com.googl /** *
* Gets an InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public com.google.privacy.dlp.v2.InspectTemplate getInspectTemplate(com.google.privacy.dlp.v2.GetInspectTemplateRequest request) { @@ -1882,6 +1999,7 @@ public com.google.privacy.dlp.v2.InspectTemplate getInspectTemplate(com.google.p /** *
* Lists InspectTemplates. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public com.google.privacy.dlp.v2.ListInspectTemplatesResponse listInspectTemplates(com.google.privacy.dlp.v2.ListInspectTemplatesRequest request) { @@ -1892,6 +2010,7 @@ public com.google.privacy.dlp.v2.ListInspectTemplatesResponse listInspectTemplat /** *
* Deletes an InspectTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates to learn more. **/ public com.google.protobuf.Empty deleteInspectTemplate(com.google.privacy.dlp.v2.DeleteInspectTemplateRequest request) { @@ -1903,6 +2022,8 @@ public com.google.protobuf.Empty deleteInspectTemplate(com.google.privacy.dlp.v2 *
* Creates a DeidentifyTemplate for re-using frequently used configuration * for de-identifying content, images, and storage. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public com.google.privacy.dlp.v2.DeidentifyTemplate createDeidentifyTemplate(com.google.privacy.dlp.v2.CreateDeidentifyTemplateRequest request) { @@ -1913,6 +2034,8 @@ public com.google.privacy.dlp.v2.DeidentifyTemplate createDeidentifyTemplate(com /** *
* Updates the DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public com.google.privacy.dlp.v2.DeidentifyTemplate updateDeidentifyTemplate(com.google.privacy.dlp.v2.UpdateDeidentifyTemplateRequest request) { @@ -1923,6 +2046,8 @@ public com.google.privacy.dlp.v2.DeidentifyTemplate updateDeidentifyTemplate(com /** *
* Gets a DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public com.google.privacy.dlp.v2.DeidentifyTemplate getDeidentifyTemplate(com.google.privacy.dlp.v2.GetDeidentifyTemplateRequest request) { @@ -1933,6 +2058,8 @@ public com.google.privacy.dlp.v2.DeidentifyTemplate getDeidentifyTemplate(com.go /** *
* Lists DeidentifyTemplates. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public com.google.privacy.dlp.v2.ListDeidentifyTemplatesResponse listDeidentifyTemplates(com.google.privacy.dlp.v2.ListDeidentifyTemplatesRequest request) { @@ -1943,6 +2070,8 @@ public com.google.privacy.dlp.v2.ListDeidentifyTemplatesResponse listDeidentifyT /** *
* Deletes a DeidentifyTemplate. + * See https://cloud.google.com/dlp/docs/creating-templates-deid to learn + * more. **/ public com.google.protobuf.Empty deleteDeidentifyTemplate(com.google.privacy.dlp.v2.DeleteDeidentifyTemplateRequest request) { @@ -1954,6 +2083,7 @@ public com.google.protobuf.Empty deleteDeidentifyTemplate(com.google.privacy.dlp *
* Creates a job trigger to run DLP actions such as scanning storage for * sensitive information on a set schedule. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public com.google.privacy.dlp.v2.JobTrigger createJobTrigger(com.google.privacy.dlp.v2.CreateJobTriggerRequest request) { @@ -1964,6 +2094,7 @@ public com.google.privacy.dlp.v2.JobTrigger createJobTrigger(com.google.privacy. /** *
* Updates a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public com.google.privacy.dlp.v2.JobTrigger updateJobTrigger(com.google.privacy.dlp.v2.UpdateJobTriggerRequest request) { @@ -1974,6 +2105,7 @@ public com.google.privacy.dlp.v2.JobTrigger updateJobTrigger(com.google.privacy. /** *
* Gets a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public com.google.privacy.dlp.v2.JobTrigger getJobTrigger(com.google.privacy.dlp.v2.GetJobTriggerRequest request) { @@ -1984,6 +2116,7 @@ public com.google.privacy.dlp.v2.JobTrigger getJobTrigger(com.google.privacy.dlp /** *
* Lists job triggers. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public com.google.privacy.dlp.v2.ListJobTriggersResponse listJobTriggers(com.google.privacy.dlp.v2.ListJobTriggersRequest request) { @@ -1994,6 +2127,7 @@ public com.google.privacy.dlp.v2.ListJobTriggersResponse listJobTriggers(com.goo /** *
* Deletes a job trigger. + * See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. **/ public com.google.protobuf.Empty deleteJobTrigger(com.google.privacy.dlp.v2.DeleteJobTriggerRequest request) { @@ -2004,7 +2138,11 @@ public com.google.protobuf.Empty deleteJobTrigger(com.google.privacy.dlp.v2.Dele /** *
* Creates a new job to inspect storage or calculate risk metrics. - * [How-to guide](/dlp/docs/compute-risk-analysis). + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. **/ public com.google.privacy.dlp.v2.DlpJob createDlpJob(com.google.privacy.dlp.v2.CreateDlpJobRequest request) { @@ -2015,6 +2153,8 @@ public com.google.privacy.dlp.v2.DlpJob createDlpJob(com.google.privacy.dlp.v2.C /** *
* Lists DlpJobs that match the specified filter in the request. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. **/ public com.google.privacy.dlp.v2.ListDlpJobsResponse listDlpJobs(com.google.privacy.dlp.v2.ListDlpJobsRequest request) { @@ -2025,6 +2165,8 @@ public com.google.privacy.dlp.v2.ListDlpJobsResponse listDlpJobs(com.google.priv /** *
* Gets the latest state of a long-running DlpJob. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. **/ public com.google.privacy.dlp.v2.DlpJob getDlpJob(com.google.privacy.dlp.v2.GetDlpJobRequest request) { @@ -2037,6 +2179,8 @@ public com.google.privacy.dlp.v2.DlpJob getDlpJob(com.google.privacy.dlp.v2.GetD * Deletes a long-running DlpJob. This method indicates that the client is * no longer interested in the DlpJob result. The job will be cancelled if * possible. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * */ public com.google.protobuf.Empty deleteDlpJob(com.google.privacy.dlp.v2.DeleteDlpJobRequest request) { @@ -2049,6 +2193,8 @@ public com.google.protobuf.Empty deleteDlpJob(com.google.privacy.dlp.v2.DeleteDl * Starts asynchronous cancellation on a long-running DlpJob. The server * makes a best effort to cancel the DlpJob, but success is not * guaranteed. + * See https://cloud.google.com/dlp/docs/inspecting-storage and + * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. * */ public com.google.protobuf.Empty cancelDlpJob(com.google.privacy.dlp.v2.CancelDlpJobRequest request) { @@ -2065,6 +2211,8 @@ public com.google.protobuf.Empty cancelDlpJob(com.google.privacy.dlp.v2.CancelDl * blocks or images. * The service also includes methods for sensitive data redaction and * scheduling of data scans on Google Cloud Platform based data sets. + * To learn more about concepts and find how-to guides see + * https://cloud.google.com/dlp/docs/. * */ public static final class DlpServiceFutureStub extends io.grpc.stub.AbstractStub
* Finds potentially sensitive info in content. * This method has limits on input size, processing time, and output size. - * [How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for - * images](/dlp/docs/inspecting-images) + * When no InfoTypes or CustomInfoTypes are specified in this request, the + * system will automatically choose what detectors to run. By default this may + * be all types, but may change over time as detectors are updated. + * For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images + * and https://cloud.google.com/dlp/docs/inspecting-text, **/ public com.google.common.util.concurrent.ListenableFuture
- * ## Log entry resources * Writes log entries to Stackdriver Logging. This API method is the * only way to send log entries to Stackdriver Logging. This method * is used, directly or indirectly, by the Stackdriver Logging agent * (fluentd) and all logging libraries configured to use Stackdriver * Logging. + * A single request may contain log entries for a maximum of 1000 + * different resources (projects, organizations, billing accounts or + * folders) **/ public void writeLogEntries(com.google.logging.v2.WriteLogEntriesRequest request, @@ -386,12 +388,14 @@ public void deleteLog(com.google.logging.v2.DeleteLogRequest request, /** *
- * ## Log entry resources * Writes log entries to Stackdriver Logging. This API method is the * only way to send log entries to Stackdriver Logging. This method * is used, directly or indirectly, by the Stackdriver Logging agent * (fluentd) and all logging libraries configured to use Stackdriver * Logging. + * A single request may contain log entries for a maximum of 1000 + * different resources (projects, organizations, billing accounts or + * folders) **/ public void writeLogEntries(com.google.logging.v2.WriteLogEntriesRequest request, @@ -474,12 +478,14 @@ public com.google.protobuf.Empty deleteLog(com.google.logging.v2.DeleteLogReques /** *
- * ## Log entry resources * Writes log entries to Stackdriver Logging. This API method is the * only way to send log entries to Stackdriver Logging. This method * is used, directly or indirectly, by the Stackdriver Logging agent * (fluentd) and all logging libraries configured to use Stackdriver * Logging. + * A single request may contain log entries for a maximum of 1000 + * different resources (projects, organizations, billing accounts or + * folders) **/ public com.google.logging.v2.WriteLogEntriesResponse writeLogEntries(com.google.logging.v2.WriteLogEntriesRequest request) { @@ -559,12 +565,14 @@ public com.google.common.util.concurrent.ListenableFuture
+ * Cloud Tasks allows developers to manage the execution of background + * work in their applications. + *+ */ +@javax.annotation.Generated( + value = "by gRPC proto compiler (version 1.10.0)", + comments = "Source: google/cloud/tasks/v2beta2/cloudtasks.proto") +public final class CloudTasksGrpc { + + private CloudTasksGrpc() {} + + public static final String SERVICE_NAME = "google.cloud.tasks.v2beta2.CloudTasks"; + + // Static method descriptors that strictly reflect the proto. + @io.grpc.ExperimentalApi("https://github.com/grpc/grpc-java/issues/1901") + @java.lang.Deprecated // Use {@link #getListQueuesMethod()} instead. + public static final io.grpc.MethodDescriptor
+ * Cloud Tasks allows developers to manage the execution of background + * work in their applications. + *+ */ + public static abstract class CloudTasksImplBase implements io.grpc.BindableService { + + /** + *
+ * Lists queues. + * Queues are returned in lexicographical order. + *+ */ + public void listQueues(com.google.cloud.tasks.v2beta2.ListQueuesRequest request, + io.grpc.stub.StreamObserver
+ * Gets a queue. + *+ */ + public void getQueue(com.google.cloud.tasks.v2beta2.GetQueueRequest request, + io.grpc.stub.StreamObserver
+ * Creates a queue. + * Queues created with this method allow tasks to live for a maximum of 31 + * days. After a task is 31 days old, the task will be deleted regardless of whether + * it was dispatched or not. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public void createQueue(com.google.cloud.tasks.v2beta2.CreateQueueRequest request, + io.grpc.stub.StreamObserver
+ * Updates a queue. + * This method creates the queue if it does not exist and updates + * the queue if it does exist. + * Queues created with this method allow tasks to live for a maximum of 31 + * days. After a task is 31 days old, the task will be deleted regardless of whether + * it was dispatched or not. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public void updateQueue(com.google.cloud.tasks.v2beta2.UpdateQueueRequest request, + io.grpc.stub.StreamObserver
+ * Deletes a queue. + * This command will delete the queue even if it has tasks in it. + * Note: If you delete a queue, a queue with the same name can't be created + * for 7 days. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public void deleteQueue(com.google.cloud.tasks.v2beta2.DeleteQueueRequest request, + io.grpc.stub.StreamObserver
+ * Purges a queue by deleting all of its tasks. + * All tasks created before this method is called are permanently deleted. + * Purge operations can take up to one minute to take effect. Tasks + * might be dispatched before the purge takes effect. A purge is irreversible. + *+ */ + public void purgeQueue(com.google.cloud.tasks.v2beta2.PurgeQueueRequest request, + io.grpc.stub.StreamObserver
+ * Pauses the queue. + * If a queue is paused then the system will stop dispatching tasks + * until the queue is resumed via + * [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added + * when the queue is paused. A queue is paused if its + * [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + *+ */ + public void pauseQueue(com.google.cloud.tasks.v2beta2.PauseQueueRequest request, + io.grpc.stub.StreamObserver
+ * Resume a queue. + * This method resumes a queue after it has been + * [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or + * [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored + * in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it + * will be set to [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING]. + * WARNING: Resuming many high-QPS queues at the same time can + * lead to target overloading. If you are resuming high-QPS + * queues, follow the 500/50/5 pattern described in + * [Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf). + *+ */ + public void resumeQueue(com.google.cloud.tasks.v2beta2.ResumeQueueRequest request, + io.grpc.stub.StreamObserver
+ * Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. + * Returns an empty policy if the resource exists and does not have a policy + * set. + * Authorization requires the following [Google IAM](/iam) permission on the + * specified resource parent: + * * `cloudtasks.queues.getIamPolicy` + *+ */ + public void getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, + io.grpc.stub.StreamObserver
+ * Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing + * policy. + * Note: The Cloud Console does not check queue-level IAM permissions yet. + * Project-level permissions are required to use the Cloud Console. + * Authorization requires the following [Google IAM](/iam) permission on the + * specified resource parent: + * * `cloudtasks.queues.setIamPolicy` + *+ */ + public void setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, + io.grpc.stub.StreamObserver
+ * Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue]. + * If the resource does not exist, this will return an empty set of + * permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error. + * Note: This operation is designed to be used for building permission-aware + * UIs and command-line tools, not for authorization checking. This operation + * may "fail open" without warning. + *+ */ + public void testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, + io.grpc.stub.StreamObserver
+ * Lists the tasks in a queue. + * By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved + * due to performance considerations; + * [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] controls the + * subset of information which is returned. + *+ */ + public void listTasks(com.google.cloud.tasks.v2beta2.ListTasksRequest request, + io.grpc.stub.StreamObserver
+ * Gets a task. + *+ */ + public void getTask(com.google.cloud.tasks.v2beta2.GetTaskRequest request, + io.grpc.stub.StreamObserver
+ * Creates a task and adds it to a queue. + * Tasks cannot be updated after creation; there is no UpdateTask command. + * * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget), + * the maximum task size is 100KB. + * * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this + * the maximum task size is 1MB. + *+ */ + public void createTask(com.google.cloud.tasks.v2beta2.CreateTaskRequest request, + io.grpc.stub.StreamObserver
+ * Deletes a task. + * A task can be deleted if it is scheduled or dispatched. A task + * cannot be deleted if it has completed successfully or permanently + * failed. + *+ */ + public void deleteTask(com.google.cloud.tasks.v2beta2.DeleteTaskRequest request, + io.grpc.stub.StreamObserver
+ * Leases tasks from a pull queue for + * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. + * This method is invoked by the worker to obtain a lease. The + * worker must acknowledge the task via + * [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have + * performed the work associated with the task. + * The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended to store data that + * the worker needs to perform the work associated with the task. To + * return the payloads in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set + * [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to + * [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]. + * A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] + * requests are allowed per + * queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + * is returned when this limit is + * exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + * is also returned when + * [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second] + * is exceeded. + *+ */ + public void leaseTasks(com.google.cloud.tasks.v2beta2.LeaseTasksRequest request, + io.grpc.stub.StreamObserver
+ * Acknowledges a pull task. + * The worker, that is, the entity that + * [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must call this method + * to indicate that the work associated with the task has finished. + * The worker must acknowledge a task within the + * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] or the lease + * will expire and the task will become available to be leased + * again. After the task is acknowledged, it will not be returned + * by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks], + * [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or + * [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]. + *+ */ + public void acknowledgeTask(com.google.cloud.tasks.v2beta2.AcknowledgeTaskRequest request, + io.grpc.stub.StreamObserver
+ * Renew the current lease of a pull task. + * The worker can use this method to extend the lease by a new + * duration, starting from now. The new task lease will be + * returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. + *+ */ + public void renewLease(com.google.cloud.tasks.v2beta2.RenewLeaseRequest request, + io.grpc.stub.StreamObserver
+ * Cancel a pull task's lease. + * The worker can use this method to cancel a task's lease by + * setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will + * make the task available to be leased to the next caller of + * [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. + *+ */ + public void cancelLease(com.google.cloud.tasks.v2beta2.CancelLeaseRequest request, + io.grpc.stub.StreamObserver
+ * Forces a task to run now. + * When this method is called, Cloud Tasks will dispatch the task, even if + * the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or + * is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + * This command is meant to be used for manual debugging. For + * example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be used to retry a failed + * task after a fix has been made or to manually force a task to be + * dispatched now. + * The dispatched task is returned. That is, the task that is returned + * contains the [status][google.cloud.tasks.v2beta2.Task.status] after the task is dispatched but + * before the task is received by its target. + * If Cloud Tasks receives a successful response from the task's + * target, then the task will be deleted; otherwise the task's + * [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be reset to the time that + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified + * in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig]. + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns + * [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a + * task that has already succeeded or permanently failed. + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a + * [pull task][google.cloud.tasks.v2beta2.PullMessage]. + *+ */ + public void runTask(com.google.cloud.tasks.v2beta2.RunTaskRequest request, + io.grpc.stub.StreamObserver
+ * Cloud Tasks allows developers to manage the execution of background + * work in their applications. + *+ */ + public static final class CloudTasksStub extends io.grpc.stub.AbstractStub
+ * Lists queues. + * Queues are returned in lexicographical order. + *+ */ + public void listQueues(com.google.cloud.tasks.v2beta2.ListQueuesRequest request, + io.grpc.stub.StreamObserver
+ * Gets a queue. + *+ */ + public void getQueue(com.google.cloud.tasks.v2beta2.GetQueueRequest request, + io.grpc.stub.StreamObserver
+ * Creates a queue. + * Queues created with this method allow tasks to live for a maximum of 31 + * days. After a task is 31 days old, the task will be deleted regardless of whether + * it was dispatched or not. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public void createQueue(com.google.cloud.tasks.v2beta2.CreateQueueRequest request, + io.grpc.stub.StreamObserver
+ * Updates a queue. + * This method creates the queue if it does not exist and updates + * the queue if it does exist. + * Queues created with this method allow tasks to live for a maximum of 31 + * days. After a task is 31 days old, the task will be deleted regardless of whether + * it was dispatched or not. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public void updateQueue(com.google.cloud.tasks.v2beta2.UpdateQueueRequest request, + io.grpc.stub.StreamObserver
+ * Deletes a queue. + * This command will delete the queue even if it has tasks in it. + * Note: If you delete a queue, a queue with the same name can't be created + * for 7 days. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public void deleteQueue(com.google.cloud.tasks.v2beta2.DeleteQueueRequest request, + io.grpc.stub.StreamObserver
+ * Purges a queue by deleting all of its tasks. + * All tasks created before this method is called are permanently deleted. + * Purge operations can take up to one minute to take effect. Tasks + * might be dispatched before the purge takes effect. A purge is irreversible. + *+ */ + public void purgeQueue(com.google.cloud.tasks.v2beta2.PurgeQueueRequest request, + io.grpc.stub.StreamObserver
+ * Pauses the queue. + * If a queue is paused then the system will stop dispatching tasks + * until the queue is resumed via + * [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added + * when the queue is paused. A queue is paused if its + * [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + *+ */ + public void pauseQueue(com.google.cloud.tasks.v2beta2.PauseQueueRequest request, + io.grpc.stub.StreamObserver
+ * Resume a queue. + * This method resumes a queue after it has been + * [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or + * [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored + * in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it + * will be set to [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING]. + * WARNING: Resuming many high-QPS queues at the same time can + * lead to target overloading. If you are resuming high-QPS + * queues, follow the 500/50/5 pattern described in + * [Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf). + *+ */ + public void resumeQueue(com.google.cloud.tasks.v2beta2.ResumeQueueRequest request, + io.grpc.stub.StreamObserver
+ * Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. + * Returns an empty policy if the resource exists and does not have a policy + * set. + * Authorization requires the following [Google IAM](/iam) permission on the + * specified resource parent: + * * `cloudtasks.queues.getIamPolicy` + *+ */ + public void getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, + io.grpc.stub.StreamObserver
+ * Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing + * policy. + * Note: The Cloud Console does not check queue-level IAM permissions yet. + * Project-level permissions are required to use the Cloud Console. + * Authorization requires the following [Google IAM](/iam) permission on the + * specified resource parent: + * * `cloudtasks.queues.setIamPolicy` + *+ */ + public void setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, + io.grpc.stub.StreamObserver
+ * Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue]. + * If the resource does not exist, this will return an empty set of + * permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error. + * Note: This operation is designed to be used for building permission-aware + * UIs and command-line tools, not for authorization checking. This operation + * may "fail open" without warning. + *+ */ + public void testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, + io.grpc.stub.StreamObserver
+ * Lists the tasks in a queue. + * By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved + * due to performance considerations; + * [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] controls the + * subset of information which is returned. + *+ */ + public void listTasks(com.google.cloud.tasks.v2beta2.ListTasksRequest request, + io.grpc.stub.StreamObserver
+ * Gets a task. + *+ */ + public void getTask(com.google.cloud.tasks.v2beta2.GetTaskRequest request, + io.grpc.stub.StreamObserver
+ * Creates a task and adds it to a queue. + * Tasks cannot be updated after creation; there is no UpdateTask command. + * * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget), + * the maximum task size is 100KB. + * * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this + * the maximum task size is 1MB. + *+ */ + public void createTask(com.google.cloud.tasks.v2beta2.CreateTaskRequest request, + io.grpc.stub.StreamObserver
+ * Deletes a task. + * A task can be deleted if it is scheduled or dispatched. A task + * cannot be deleted if it has completed successfully or permanently + * failed. + *+ */ + public void deleteTask(com.google.cloud.tasks.v2beta2.DeleteTaskRequest request, + io.grpc.stub.StreamObserver
+ * Leases tasks from a pull queue for + * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. + * This method is invoked by the worker to obtain a lease. The + * worker must acknowledge the task via + * [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have + * performed the work associated with the task. + * The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended to store data that + * the worker needs to perform the work associated with the task. To + * return the payloads in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set + * [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to + * [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]. + * A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] + * requests are allowed per + * queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + * is returned when this limit is + * exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + * is also returned when + * [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second] + * is exceeded. + *+ */ + public void leaseTasks(com.google.cloud.tasks.v2beta2.LeaseTasksRequest request, + io.grpc.stub.StreamObserver
+ * Acknowledges a pull task. + * The worker, that is, the entity that + * [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must call this method + * to indicate that the work associated with the task has finished. + * The worker must acknowledge a task within the + * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] or the lease + * will expire and the task will become available to be leased + * again. After the task is acknowledged, it will not be returned + * by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks], + * [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or + * [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]. + *+ */ + public void acknowledgeTask(com.google.cloud.tasks.v2beta2.AcknowledgeTaskRequest request, + io.grpc.stub.StreamObserver
+ * Renew the current lease of a pull task. + * The worker can use this method to extend the lease by a new + * duration, starting from now. The new task lease will be + * returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. + *+ */ + public void renewLease(com.google.cloud.tasks.v2beta2.RenewLeaseRequest request, + io.grpc.stub.StreamObserver
+ * Cancel a pull task's lease. + * The worker can use this method to cancel a task's lease by + * setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will + * make the task available to be leased to the next caller of + * [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. + *+ */ + public void cancelLease(com.google.cloud.tasks.v2beta2.CancelLeaseRequest request, + io.grpc.stub.StreamObserver
+ * Forces a task to run now. + * When this method is called, Cloud Tasks will dispatch the task, even if + * the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or + * is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + * This command is meant to be used for manual debugging. For + * example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be used to retry a failed + * task after a fix has been made or to manually force a task to be + * dispatched now. + * The dispatched task is returned. That is, the task that is returned + * contains the [status][google.cloud.tasks.v2beta2.Task.status] after the task is dispatched but + * before the task is received by its target. + * If Cloud Tasks receives a successful response from the task's + * target, then the task will be deleted; otherwise the task's + * [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be reset to the time that + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified + * in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig]. + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns + * [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a + * task that has already succeeded or permanently failed. + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a + * [pull task][google.cloud.tasks.v2beta2.PullMessage]. + *+ */ + public void runTask(com.google.cloud.tasks.v2beta2.RunTaskRequest request, + io.grpc.stub.StreamObserver
+ * Cloud Tasks allows developers to manage the execution of background + * work in their applications. + *+ */ + public static final class CloudTasksBlockingStub extends io.grpc.stub.AbstractStub
+ * Lists queues. + * Queues are returned in lexicographical order. + *+ */ + public com.google.cloud.tasks.v2beta2.ListQueuesResponse listQueues(com.google.cloud.tasks.v2beta2.ListQueuesRequest request) { + return blockingUnaryCall( + getChannel(), getListQueuesMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Gets a queue. + *+ */ + public com.google.cloud.tasks.v2beta2.Queue getQueue(com.google.cloud.tasks.v2beta2.GetQueueRequest request) { + return blockingUnaryCall( + getChannel(), getGetQueueMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Creates a queue. + * Queues created with this method allow tasks to live for a maximum of 31 + * days. After a task is 31 days old, the task will be deleted regardless of whether + * it was dispatched or not. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public com.google.cloud.tasks.v2beta2.Queue createQueue(com.google.cloud.tasks.v2beta2.CreateQueueRequest request) { + return blockingUnaryCall( + getChannel(), getCreateQueueMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Updates a queue. + * This method creates the queue if it does not exist and updates + * the queue if it does exist. + * Queues created with this method allow tasks to live for a maximum of 31 + * days. After a task is 31 days old, the task will be deleted regardless of whether + * it was dispatched or not. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public com.google.cloud.tasks.v2beta2.Queue updateQueue(com.google.cloud.tasks.v2beta2.UpdateQueueRequest request) { + return blockingUnaryCall( + getChannel(), getUpdateQueueMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Deletes a queue. + * This command will delete the queue even if it has tasks in it. + * Note: If you delete a queue, a queue with the same name can't be created + * for 7 days. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public com.google.protobuf.Empty deleteQueue(com.google.cloud.tasks.v2beta2.DeleteQueueRequest request) { + return blockingUnaryCall( + getChannel(), getDeleteQueueMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Purges a queue by deleting all of its tasks. + * All tasks created before this method is called are permanently deleted. + * Purge operations can take up to one minute to take effect. Tasks + * might be dispatched before the purge takes effect. A purge is irreversible. + *+ */ + public com.google.cloud.tasks.v2beta2.Queue purgeQueue(com.google.cloud.tasks.v2beta2.PurgeQueueRequest request) { + return blockingUnaryCall( + getChannel(), getPurgeQueueMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Pauses the queue. + * If a queue is paused then the system will stop dispatching tasks + * until the queue is resumed via + * [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added + * when the queue is paused. A queue is paused if its + * [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + *+ */ + public com.google.cloud.tasks.v2beta2.Queue pauseQueue(com.google.cloud.tasks.v2beta2.PauseQueueRequest request) { + return blockingUnaryCall( + getChannel(), getPauseQueueMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Resume a queue. + * This method resumes a queue after it has been + * [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or + * [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored + * in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it + * will be set to [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING]. + * WARNING: Resuming many high-QPS queues at the same time can + * lead to target overloading. If you are resuming high-QPS + * queues, follow the 500/50/5 pattern described in + * [Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf). + *+ */ + public com.google.cloud.tasks.v2beta2.Queue resumeQueue(com.google.cloud.tasks.v2beta2.ResumeQueueRequest request) { + return blockingUnaryCall( + getChannel(), getResumeQueueMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. + * Returns an empty policy if the resource exists and does not have a policy + * set. + * Authorization requires the following [Google IAM](/iam) permission on the + * specified resource parent: + * * `cloudtasks.queues.getIamPolicy` + *+ */ + public com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) { + return blockingUnaryCall( + getChannel(), getGetIamPolicyMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing + * policy. + * Note: The Cloud Console does not check queue-level IAM permissions yet. + * Project-level permissions are required to use the Cloud Console. + * Authorization requires the following [Google IAM](/iam) permission on the + * specified resource parent: + * * `cloudtasks.queues.setIamPolicy` + *+ */ + public com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) { + return blockingUnaryCall( + getChannel(), getSetIamPolicyMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue]. + * If the resource does not exist, this will return an empty set of + * permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error. + * Note: This operation is designed to be used for building permission-aware + * UIs and command-line tools, not for authorization checking. This operation + * may "fail open" without warning. + *+ */ + public com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) { + return blockingUnaryCall( + getChannel(), getTestIamPermissionsMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Lists the tasks in a queue. + * By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved + * due to performance considerations; + * [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] controls the + * subset of information which is returned. + *+ */ + public com.google.cloud.tasks.v2beta2.ListTasksResponse listTasks(com.google.cloud.tasks.v2beta2.ListTasksRequest request) { + return blockingUnaryCall( + getChannel(), getListTasksMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Gets a task. + *+ */ + public com.google.cloud.tasks.v2beta2.Task getTask(com.google.cloud.tasks.v2beta2.GetTaskRequest request) { + return blockingUnaryCall( + getChannel(), getGetTaskMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Creates a task and adds it to a queue. + * Tasks cannot be updated after creation; there is no UpdateTask command. + * * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget), + * the maximum task size is 100KB. + * * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this + * the maximum task size is 1MB. + *+ */ + public com.google.cloud.tasks.v2beta2.Task createTask(com.google.cloud.tasks.v2beta2.CreateTaskRequest request) { + return blockingUnaryCall( + getChannel(), getCreateTaskMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Deletes a task. + * A task can be deleted if it is scheduled or dispatched. A task + * cannot be deleted if it has completed successfully or permanently + * failed. + *+ */ + public com.google.protobuf.Empty deleteTask(com.google.cloud.tasks.v2beta2.DeleteTaskRequest request) { + return blockingUnaryCall( + getChannel(), getDeleteTaskMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Leases tasks from a pull queue for + * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. + * This method is invoked by the worker to obtain a lease. The + * worker must acknowledge the task via + * [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have + * performed the work associated with the task. + * The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended to store data that + * the worker needs to perform the work associated with the task. To + * return the payloads in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set + * [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to + * [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]. + * A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] + * requests are allowed per + * queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + * is returned when this limit is + * exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + * is also returned when + * [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second] + * is exceeded. + *+ */ + public com.google.cloud.tasks.v2beta2.LeaseTasksResponse leaseTasks(com.google.cloud.tasks.v2beta2.LeaseTasksRequest request) { + return blockingUnaryCall( + getChannel(), getLeaseTasksMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Acknowledges a pull task. + * The worker, that is, the entity that + * [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must call this method + * to indicate that the work associated with the task has finished. + * The worker must acknowledge a task within the + * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] or the lease + * will expire and the task will become available to be leased + * again. After the task is acknowledged, it will not be returned + * by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks], + * [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or + * [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]. + *+ */ + public com.google.protobuf.Empty acknowledgeTask(com.google.cloud.tasks.v2beta2.AcknowledgeTaskRequest request) { + return blockingUnaryCall( + getChannel(), getAcknowledgeTaskMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Renew the current lease of a pull task. + * The worker can use this method to extend the lease by a new + * duration, starting from now. The new task lease will be + * returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. + *+ */ + public com.google.cloud.tasks.v2beta2.Task renewLease(com.google.cloud.tasks.v2beta2.RenewLeaseRequest request) { + return blockingUnaryCall( + getChannel(), getRenewLeaseMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Cancel a pull task's lease. + * The worker can use this method to cancel a task's lease by + * setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will + * make the task available to be leased to the next caller of + * [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. + *+ */ + public com.google.cloud.tasks.v2beta2.Task cancelLease(com.google.cloud.tasks.v2beta2.CancelLeaseRequest request) { + return blockingUnaryCall( + getChannel(), getCancelLeaseMethodHelper(), getCallOptions(), request); + } + + /** + *
+ * Forces a task to run now. + * When this method is called, Cloud Tasks will dispatch the task, even if + * the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or + * is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + * This command is meant to be used for manual debugging. For + * example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be used to retry a failed + * task after a fix has been made or to manually force a task to be + * dispatched now. + * The dispatched task is returned. That is, the task that is returned + * contains the [status][google.cloud.tasks.v2beta2.Task.status] after the task is dispatched but + * before the task is received by its target. + * If Cloud Tasks receives a successful response from the task's + * target, then the task will be deleted; otherwise the task's + * [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be reset to the time that + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified + * in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig]. + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns + * [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a + * task that has already succeeded or permanently failed. + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a + * [pull task][google.cloud.tasks.v2beta2.PullMessage]. + *+ */ + public com.google.cloud.tasks.v2beta2.Task runTask(com.google.cloud.tasks.v2beta2.RunTaskRequest request) { + return blockingUnaryCall( + getChannel(), getRunTaskMethodHelper(), getCallOptions(), request); + } + } + + /** + *
+ * Cloud Tasks allows developers to manage the execution of background + * work in their applications. + *+ */ + public static final class CloudTasksFutureStub extends io.grpc.stub.AbstractStub
+ * Lists queues. + * Queues are returned in lexicographical order. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Gets a queue. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Creates a queue. + * Queues created with this method allow tasks to live for a maximum of 31 + * days. After a task is 31 days old, the task will be deleted regardless of whether + * it was dispatched or not. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Updates a queue. + * This method creates the queue if it does not exist and updates + * the queue if it does exist. + * Queues created with this method allow tasks to live for a maximum of 31 + * days. After a task is 31 days old, the task will be deleted regardless of whether + * it was dispatched or not. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Deletes a queue. + * This command will delete the queue even if it has tasks in it. + * Note: If you delete a queue, a queue with the same name can't be created + * for 7 days. + * WARNING: Using this method may have unintended side effects if you are + * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + * Read + * [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) + * before using this method. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Purges a queue by deleting all of its tasks. + * All tasks created before this method is called are permanently deleted. + * Purge operations can take up to one minute to take effect. Tasks + * might be dispatched before the purge takes effect. A purge is irreversible. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Pauses the queue. + * If a queue is paused then the system will stop dispatching tasks + * until the queue is resumed via + * [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added + * when the queue is paused. A queue is paused if its + * [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Resume a queue. + * This method resumes a queue after it has been + * [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or + * [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored + * in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it + * will be set to [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING]. + * WARNING: Resuming many high-QPS queues at the same time can + * lead to target overloading. If you are resuming high-QPS + * queues, follow the 500/50/5 pattern described in + * [Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf). + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. + * Returns an empty policy if the resource exists and does not have a policy + * set. + * Authorization requires the following [Google IAM](/iam) permission on the + * specified resource parent: + * * `cloudtasks.queues.getIamPolicy` + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing + * policy. + * Note: The Cloud Console does not check queue-level IAM permissions yet. + * Project-level permissions are required to use the Cloud Console. + * Authorization requires the following [Google IAM](/iam) permission on the + * specified resource parent: + * * `cloudtasks.queues.setIamPolicy` + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue]. + * If the resource does not exist, this will return an empty set of + * permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error. + * Note: This operation is designed to be used for building permission-aware + * UIs and command-line tools, not for authorization checking. This operation + * may "fail open" without warning. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Lists the tasks in a queue. + * By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved + * due to performance considerations; + * [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] controls the + * subset of information which is returned. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Gets a task. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Creates a task and adds it to a queue. + * Tasks cannot be updated after creation; there is no UpdateTask command. + * * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget), + * the maximum task size is 100KB. + * * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this + * the maximum task size is 1MB. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Deletes a task. + * A task can be deleted if it is scheduled or dispatched. A task + * cannot be deleted if it has completed successfully or permanently + * failed. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Leases tasks from a pull queue for + * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. + * This method is invoked by the worker to obtain a lease. The + * worker must acknowledge the task via + * [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have + * performed the work associated with the task. + * The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended to store data that + * the worker needs to perform the work associated with the task. To + * return the payloads in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set + * [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to + * [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]. + * A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] + * requests are allowed per + * queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + * is returned when this limit is + * exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + * is also returned when + * [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second] + * is exceeded. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Acknowledges a pull task. + * The worker, that is, the entity that + * [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must call this method + * to indicate that the work associated with the task has finished. + * The worker must acknowledge a task within the + * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] or the lease + * will expire and the task will become available to be leased + * again. After the task is acknowledged, it will not be returned + * by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks], + * [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or + * [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Renew the current lease of a pull task. + * The worker can use this method to extend the lease by a new + * duration, starting from now. The new task lease will be + * returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Cancel a pull task's lease. + * The worker can use this method to cancel a task's lease by + * setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will + * make the task available to be leased to the next caller of + * [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. + *+ */ + public com.google.common.util.concurrent.ListenableFuture
+ * Forces a task to run now. + * When this method is called, Cloud Tasks will dispatch the task, even if + * the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or + * is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + * This command is meant to be used for manual debugging. For + * example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be used to retry a failed + * task after a fix has been made or to manually force a task to be + * dispatched now. + * The dispatched task is returned. That is, the task that is returned + * contains the [status][google.cloud.tasks.v2beta2.Task.status] after the task is dispatched but + * before the task is received by its target. + * If Cloud Tasks receives a successful response from the task's + * target, then the task will be deleted; otherwise the task's + * [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be reset to the time that + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified + * in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig]. + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns + * [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a + * task that has already succeeded or permanently failed. + * [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a + * [pull task][google.cloud.tasks.v2beta2.PullMessage]. + *+ */ + public com.google.common.util.concurrent.ListenableFuture