-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(samples): added basic samples and tests (#43)
* docs(samples): added basic samples and tests * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * minor refactoring * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * updated comments Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
97413e7
commit 9855f8c
Showing
7 changed files
with
580 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
java-batch/samples/snippets/src/main/java/CreateWithContainerNoMounting.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Copyright 2022 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // [START batch_create_container_job] | ||
|
|
||
| import com.google.cloud.batch.v1.AllocationPolicy; | ||
| import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicy; | ||
| import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate; | ||
| import com.google.cloud.batch.v1.BatchServiceClient; | ||
| import com.google.cloud.batch.v1.ComputeResource; | ||
| import com.google.cloud.batch.v1.CreateJobRequest; | ||
| import com.google.cloud.batch.v1.Job; | ||
| import com.google.cloud.batch.v1.LogsPolicy; | ||
| import com.google.cloud.batch.v1.LogsPolicy.Destination; | ||
| import com.google.cloud.batch.v1.Runnable; | ||
| import com.google.cloud.batch.v1.Runnable.Container; | ||
| import com.google.cloud.batch.v1.TaskGroup; | ||
| import com.google.cloud.batch.v1.TaskSpec; | ||
| import com.google.protobuf.Duration; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| public class CreateWithContainerNoMounting { | ||
|
|
||
| public static void main(String[] args) | ||
| throws IOException, ExecutionException, InterruptedException, TimeoutException { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| // Project ID or project number of the Cloud project you want to use. | ||
| String projectId = "YOUR_PROJECT_ID"; | ||
|
|
||
| // Name of the region you want to use to run the job. Regions that are | ||
| // available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations | ||
| String region = "europe-central2"; | ||
|
|
||
| // The name of the job that will be created. | ||
| // It needs to be unique for each project and region pair. | ||
| String jobName = "JOB_NAME"; | ||
|
|
||
| createContainerJob(projectId, region, jobName); | ||
| } | ||
|
|
||
| // This method shows how to create a sample Batch Job that will run a simple command inside a | ||
| // container on Cloud Compute instances. | ||
| public static void createContainerJob(String projectId, String region, String jobName) | ||
| throws IOException, ExecutionException, InterruptedException, TimeoutException { | ||
| // Initialize client that will be used to send requests. This client only needs to be created | ||
| // once, and can be reused for multiple requests. After completing all of your requests, call | ||
| // the `batchServiceClient.close()` method on the client to safely | ||
| // clean up any remaining background resources. | ||
| try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) { | ||
|
|
||
| // Define what will be done as part of the job. | ||
| Runnable runnable = | ||
| Runnable.newBuilder() | ||
| .setContainer( | ||
| Container.newBuilder() | ||
| .setImageUri("gcr.io/google-containers/busybox") | ||
| .setEntrypoint("/bin/sh") | ||
| .addCommands("-c") | ||
| .addCommands( | ||
| "echo Hello world! This is task ${BATCH_TASK_INDEX}. " | ||
| + "This job has a total of ${BATCH_TASK_COUNT} tasks.") | ||
| .build()) | ||
| .build(); | ||
|
|
||
| // We can specify what resources are requested by each task. | ||
| ComputeResource computeResource = | ||
| ComputeResource.newBuilder() | ||
| // In milliseconds per cpu-second. This means the task requires 2 whole CPUs. | ||
| .setCpuMilli(2000) | ||
| // In MiB. | ||
| .setMemoryMib(16) | ||
| .build(); | ||
|
|
||
| TaskSpec task = | ||
| TaskSpec.newBuilder() | ||
| // Jobs can be divided into tasks. In this case, we have only one task. | ||
| .addRunnables(runnable) | ||
| .setComputeResource(computeResource) | ||
| .setMaxRetryCount(2) | ||
| .setMaxRunDuration(Duration.newBuilder().setSeconds(3600).build()) | ||
| .build(); | ||
|
|
||
| // Tasks are grouped inside a job using TaskGroups. | ||
| TaskGroup taskGroup = TaskGroup.newBuilder().setTaskCount(4).setTaskSpec(task).build(); | ||
|
|
||
| // Policies are used to define on what kind of virtual machines the tasks will run on. | ||
| // In this case, we tell the system to use "e2-standard-4" machine type. | ||
| // Read more about machine types here: https://cloud.google.com/compute/docs/machine-types | ||
| InstancePolicy instancePolicy = | ||
| InstancePolicy.newBuilder().setMachineType("e2-standard-4").build(); | ||
|
|
||
| AllocationPolicy allocationPolicy = | ||
| AllocationPolicy.newBuilder() | ||
| .addInstances(InstancePolicyOrTemplate.newBuilder().setPolicy(instancePolicy).build()) | ||
| .build(); | ||
|
|
||
| Job job = | ||
| Job.newBuilder() | ||
| .addTaskGroups(taskGroup) | ||
| .setAllocationPolicy(allocationPolicy) | ||
| .putLabels("env", "testing") | ||
| .putLabels("type", "container") | ||
| // We use Cloud Logging as it's an out of the box available option. | ||
| .setLogsPolicy( | ||
| LogsPolicy.newBuilder().setDestination(Destination.CLOUD_LOGGING).build()) | ||
| .build(); | ||
|
|
||
| CreateJobRequest createJobRequest = | ||
| CreateJobRequest.newBuilder() | ||
| // The job's parent is the region in which the job will run. | ||
| .setParent(String.format("projects/%s/locations/%s", projectId, region)) | ||
| .setJob(job) | ||
| .setJobId(jobName) | ||
| .build(); | ||
|
|
||
| Job result = | ||
| batchServiceClient | ||
| .createJobCallable() | ||
| .futureCall(createJobRequest) | ||
| .get(3, TimeUnit.MINUTES); | ||
|
|
||
| System.out.printf("Successfully created the job: %s", result.getName()); | ||
| } | ||
| } | ||
| } | ||
| // [END batch_create_container_job] |
141 changes: 141 additions & 0 deletions
141
java-batch/samples/snippets/src/main/java/CreateWithScriptNoMounting.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| // Copyright 2022 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // [START batch_create_script_job] | ||
|
|
||
| import com.google.cloud.batch.v1.AllocationPolicy; | ||
| import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicy; | ||
| import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate; | ||
| import com.google.cloud.batch.v1.BatchServiceClient; | ||
| import com.google.cloud.batch.v1.ComputeResource; | ||
| import com.google.cloud.batch.v1.CreateJobRequest; | ||
| import com.google.cloud.batch.v1.Job; | ||
| import com.google.cloud.batch.v1.LogsPolicy; | ||
| import com.google.cloud.batch.v1.LogsPolicy.Destination; | ||
| import com.google.cloud.batch.v1.Runnable; | ||
| import com.google.cloud.batch.v1.Runnable.Script; | ||
| import com.google.cloud.batch.v1.TaskGroup; | ||
| import com.google.cloud.batch.v1.TaskSpec; | ||
| import com.google.protobuf.Duration; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| public class CreateWithScriptNoMounting { | ||
|
|
||
| public static void main(String[] args) | ||
| throws IOException, ExecutionException, InterruptedException, TimeoutException { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| // Project ID or project number of the Cloud project you want to use. | ||
| String projectId = "YOUR_PROJECT_ID"; | ||
|
|
||
| // Name of the region you want to use to run the job. Regions that are | ||
| // available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations | ||
| String region = "europe-central2"; | ||
|
|
||
| // The name of the job that will be created. | ||
| // It needs to be unique for each project and region pair. | ||
| String jobName = "JOB_NAME"; | ||
|
|
||
| createScriptJob(projectId, region, jobName); | ||
| } | ||
|
|
||
| // This method shows how to create a sample Batch Job that will run | ||
| // a simple command on Cloud Compute instances. | ||
| public static void createScriptJob(String projectId, String region, String jobName) | ||
| throws IOException, ExecutionException, InterruptedException, TimeoutException { | ||
| // Initialize client that will be used to send requests. This client only needs to be created | ||
| // once, and can be reused for multiple requests. After completing all of your requests, call | ||
| // the `batchServiceClient.close()` method on the client to safely | ||
| // clean up any remaining background resources. | ||
| try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) { | ||
|
|
||
| // Define what will be done as part of the job. | ||
| Runnable runnable = | ||
| Runnable.newBuilder() | ||
| .setScript( | ||
| Script.newBuilder() | ||
| .setText( | ||
| "echo Hello world! This is task ${BATCH_TASK_INDEX}. " | ||
| + "This job has a total of ${BATCH_TASK_COUNT} tasks.") | ||
| // You can also run a script from a file. Just remember, that needs to be a | ||
| // script that's already on the VM that will be running the job. | ||
| // Using setText() and setPath() is mutually exclusive. | ||
| // .setPath("/tmp/test.sh") | ||
| .build()) | ||
| .build(); | ||
|
|
||
| // We can specify what resources are requested by each task. | ||
| ComputeResource computeResource = | ||
| ComputeResource.newBuilder() | ||
| // In milliseconds per cpu-second. This means the task requires 2 whole CPUs. | ||
| .setCpuMilli(2000) | ||
| // In MiB. | ||
| .setMemoryMib(16) | ||
| .build(); | ||
|
|
||
| TaskSpec task = | ||
| TaskSpec.newBuilder() | ||
| // Jobs can be divided into tasks. In this case, we have only one task. | ||
| .addRunnables(runnable) | ||
| .setComputeResource(computeResource) | ||
| .setMaxRetryCount(2) | ||
| .setMaxRunDuration(Duration.newBuilder().setSeconds(3600).build()) | ||
| .build(); | ||
|
|
||
| // Tasks are grouped inside a job using TaskGroups. | ||
| TaskGroup taskGroup = TaskGroup.newBuilder().setTaskCount(4).setTaskSpec(task).build(); | ||
|
|
||
| // Policies are used to define on what kind of virtual machines the tasks will run on. | ||
| // In this case, we tell the system to use "e2-standard-4" machine type. | ||
| // Read more about machine types here: https://cloud.google.com/compute/docs/machine-types | ||
| InstancePolicy instancePolicy = | ||
| InstancePolicy.newBuilder().setMachineType("e2-standard-4").build(); | ||
|
|
||
| AllocationPolicy allocationPolicy = | ||
| AllocationPolicy.newBuilder() | ||
| .addInstances(InstancePolicyOrTemplate.newBuilder().setPolicy(instancePolicy).build()) | ||
| .build(); | ||
|
|
||
| Job job = | ||
| Job.newBuilder() | ||
| .addTaskGroups(taskGroup) | ||
| .setAllocationPolicy(allocationPolicy) | ||
| .putLabels("env", "testing") | ||
| .putLabels("type", "script") | ||
| // We use Cloud Logging as it's an out of the box available option. | ||
| .setLogsPolicy( | ||
| LogsPolicy.newBuilder().setDestination(Destination.CLOUD_LOGGING).build()) | ||
| .build(); | ||
|
|
||
| CreateJobRequest createJobRequest = | ||
| CreateJobRequest.newBuilder() | ||
| // The job's parent is the region in which the job will run. | ||
| .setParent(String.format("projects/%s/locations/%s", projectId, region)) | ||
| .setJob(job) | ||
| .setJobId(jobName) | ||
| .build(); | ||
|
|
||
| Job result = | ||
| batchServiceClient | ||
| .createJobCallable() | ||
| .futureCall(createJobRequest) | ||
| .get(3, TimeUnit.MINUTES); | ||
|
|
||
| System.out.printf("Successfully created the job: %s", result.getName()); | ||
| } | ||
| } | ||
| } | ||
| // [END batch_create_script_job] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // Copyright 2022 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // [START batch_delete_job] | ||
|
|
||
| import com.google.cloud.batch.v1.BatchServiceClient; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| public class DeleteJob { | ||
|
|
||
| public static void main(String[] args) | ||
| throws IOException, ExecutionException, InterruptedException, TimeoutException { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| // Project ID or project number of the Cloud project you want to use. | ||
| String projectId = "YOUR_PROJECT_ID"; | ||
|
|
||
| // Name of the region hosts the job. | ||
| String region = "europe-central2"; | ||
|
|
||
| // The name of the job that you want to delete. | ||
| String jobName = "JOB_NAME"; | ||
|
|
||
| deleteJob(projectId, region, jobName); | ||
| } | ||
|
|
||
| // Triggers the deletion of a Job. | ||
| public static void deleteJob(String projectId, String region, String jobName) | ||
| throws IOException, ExecutionException, InterruptedException, TimeoutException { | ||
| // Initialize client that will be used to send requests. This client only needs to be created | ||
| // once, and can be reused for multiple requests. After completing all of your requests, call | ||
| // the `batchServiceClient.close()` method on the client to safely | ||
| // clean up any remaining background resources. | ||
| try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) { | ||
|
|
||
| // Construct the parent path of the job. | ||
| String name = String.format("projects/%s/locations/%s/jobs/%s", projectId, region, jobName); | ||
|
|
||
| batchServiceClient.deleteJobAsync(name).get(3, TimeUnit.MINUTES); | ||
| System.out.printf("Delete the job: %s", jobName); | ||
| } | ||
| } | ||
| } | ||
| // [END batch_delete_job] |
Oops, something went wrong.