com.google.api.services.run.v2.model.GoogleCloudRunV2Task Maven / Gradle / Ivy
/*
* 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.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.run.v2.model;
/**
* Task represents a single run of a container to completion.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Cloud Run Admin API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class GoogleCloudRunV2Task extends com.google.api.client.json.GenericJson {
/**
* Output only. Unstructured key value map that may be set by external tools to store and
* arbitrary metadata. They are not queryable and should be preserved when modifying objects.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map annotations;
/**
* Output only. Represents time when the Task was completed. It is not guaranteed to be set in
* happens-before order across separate operations.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String completionTime;
/**
* Output only. The Condition of this Task, containing its readiness status, and detailed error
* information in case it did not reach the desired state.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List conditions;
static {
// hack to force ProGuard to consider GoogleCloudRunV2Condition used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(GoogleCloudRunV2Condition.class);
}
/**
* Holds the single container that defines the unit of execution for this task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List containers;
static {
// hack to force ProGuard to consider GoogleCloudRunV2Container used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(GoogleCloudRunV2Container.class);
}
/**
* Output only. Represents time when the task was created by the system. It is not guaranteed to
* be set in happens-before order across separate operations.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String createTime;
/**
* Output only. For a deleted resource, the deletion time. It is only populated as a response to a
* Delete request.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String deleteTime;
/**
* Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this
* container image. For more information, go to https://cloud.google.com/run/docs/securing/using-
* cmek
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String encryptionKey;
/**
* Output only. A system-generated fingerprint for this version of the resource. May be used to
* detect modification conflict during updates.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String etag;
/**
* Output only. The name of the parent Execution.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String execution;
/**
* The execution environment being used to host this Task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String executionEnvironment;
/**
* Output only. For a deleted resource, the time after which it will be permamently deleted. It is
* only populated as a response to a Delete request.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String expireTime;
/**
* Output only. A number that monotonically increases every time the user modifies the desired
* state.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long generation;
/**
* Output only. Index of the Task, unique per execution, and beginning at 0.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer index;
/**
* Output only. The name of the parent Job.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String job;
/**
* Output only. Unstructured key value map that can be used to organize and categorize objects.
* User-provided labels are shared with Google's billing system, so they can be used to filter, or
* break down billing charges by team, component, environment, state, etc. For more information,
* visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or
* https://cloud.google.com/run/docs/configuring/labels
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map labels;
/**
* Output only. Result of the last attempt of this Task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudRunV2TaskAttemptResult lastAttemptResult;
/**
* Output only. URI where logs for this execution can be found in Cloud Console.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String logUri;
/**
* Number of retries allowed per Task, before marking this Task failed.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer maxRetries;
/**
* Output only. The unique name of this Task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* Output only. The generation of this Task. See comments in `Job.reconciling` for additional
* information on reconciliation process in Cloud Run.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long observedGeneration;
/**
* Output only. Indicates whether the resource's reconciliation is still in progress. See comments
* in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean reconciling;
/**
* Output only. The number of times this Task was retried. Tasks are retried when they fail up to
* the maxRetries limit.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer retried;
/**
* Output only. Reserved for future use.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean satisfiesPzs;
/**
* Output only. Represents time when the task was scheduled to run by the system. It is not
* guaranteed to be set in happens-before order across separate operations.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String scheduledTime;
/**
* Email address of the IAM service account associated with the Task of a Job. The service account
* represents the identity of the running task, and determines what permissions the task has. If
* not provided, the task will use the project's default service account.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String serviceAccount;
/**
* Output only. Represents time when the task started to run. It is not guaranteed to be set in
* happens-before order across separate operations.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String startTime;
/**
* Max allowed time duration the Task may be active before the system will actively try to mark it
* failed and kill associated containers. This applies per attempt of a task, meaning each retry
* can run for the full timeout.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String timeout;
/**
* Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and
* guaranteed to remain unchanged until the resource is deleted.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String uid;
/**
* Output only. The last-modified time.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String updateTime;
/**
* A list of Volumes to make available to containers.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List volumes;
/**
* Output only. VPC Access configuration to use for this Task. For more information, visit
* https://cloud.google.com/run/docs/configuring/connecting-vpc.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudRunV2VpcAccess vpcAccess;
/**
* Output only. Unstructured key value map that may be set by external tools to store and
* arbitrary metadata. They are not queryable and should be preserved when modifying objects.
* @return value or {@code null} for none
*/
public java.util.Map getAnnotations() {
return annotations;
}
/**
* Output only. Unstructured key value map that may be set by external tools to store and
* arbitrary metadata. They are not queryable and should be preserved when modifying objects.
* @param annotations annotations or {@code null} for none
*/
public GoogleCloudRunV2Task setAnnotations(java.util.Map annotations) {
this.annotations = annotations;
return this;
}
/**
* Output only. Represents time when the Task was completed. It is not guaranteed to be set in
* happens-before order across separate operations.
* @return value or {@code null} for none
*/
public String getCompletionTime() {
return completionTime;
}
/**
* Output only. Represents time when the Task was completed. It is not guaranteed to be set in
* happens-before order across separate operations.
* @param completionTime completionTime or {@code null} for none
*/
public GoogleCloudRunV2Task setCompletionTime(String completionTime) {
this.completionTime = completionTime;
return this;
}
/**
* Output only. The Condition of this Task, containing its readiness status, and detailed error
* information in case it did not reach the desired state.
* @return value or {@code null} for none
*/
public java.util.List getConditions() {
return conditions;
}
/**
* Output only. The Condition of this Task, containing its readiness status, and detailed error
* information in case it did not reach the desired state.
* @param conditions conditions or {@code null} for none
*/
public GoogleCloudRunV2Task setConditions(java.util.List conditions) {
this.conditions = conditions;
return this;
}
/**
* Holds the single container that defines the unit of execution for this task.
* @return value or {@code null} for none
*/
public java.util.List getContainers() {
return containers;
}
/**
* Holds the single container that defines the unit of execution for this task.
* @param containers containers or {@code null} for none
*/
public GoogleCloudRunV2Task setContainers(java.util.List containers) {
this.containers = containers;
return this;
}
/**
* Output only. Represents time when the task was created by the system. It is not guaranteed to
* be set in happens-before order across separate operations.
* @return value or {@code null} for none
*/
public String getCreateTime() {
return createTime;
}
/**
* Output only. Represents time when the task was created by the system. It is not guaranteed to
* be set in happens-before order across separate operations.
* @param createTime createTime or {@code null} for none
*/
public GoogleCloudRunV2Task setCreateTime(String createTime) {
this.createTime = createTime;
return this;
}
/**
* Output only. For a deleted resource, the deletion time. It is only populated as a response to a
* Delete request.
* @return value or {@code null} for none
*/
public String getDeleteTime() {
return deleteTime;
}
/**
* Output only. For a deleted resource, the deletion time. It is only populated as a response to a
* Delete request.
* @param deleteTime deleteTime or {@code null} for none
*/
public GoogleCloudRunV2Task setDeleteTime(String deleteTime) {
this.deleteTime = deleteTime;
return this;
}
/**
* Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this
* container image. For more information, go to https://cloud.google.com/run/docs/securing/using-
* cmek
* @return value or {@code null} for none
*/
public java.lang.String getEncryptionKey() {
return encryptionKey;
}
/**
* Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this
* container image. For more information, go to https://cloud.google.com/run/docs/securing/using-
* cmek
* @param encryptionKey encryptionKey or {@code null} for none
*/
public GoogleCloudRunV2Task setEncryptionKey(java.lang.String encryptionKey) {
this.encryptionKey = encryptionKey;
return this;
}
/**
* Output only. A system-generated fingerprint for this version of the resource. May be used to
* detect modification conflict during updates.
* @return value or {@code null} for none
*/
public java.lang.String getEtag() {
return etag;
}
/**
* Output only. A system-generated fingerprint for this version of the resource. May be used to
* detect modification conflict during updates.
* @param etag etag or {@code null} for none
*/
public GoogleCloudRunV2Task setEtag(java.lang.String etag) {
this.etag = etag;
return this;
}
/**
* Output only. The name of the parent Execution.
* @return value or {@code null} for none
*/
public java.lang.String getExecution() {
return execution;
}
/**
* Output only. The name of the parent Execution.
* @param execution execution or {@code null} for none
*/
public GoogleCloudRunV2Task setExecution(java.lang.String execution) {
this.execution = execution;
return this;
}
/**
* The execution environment being used to host this Task.
* @return value or {@code null} for none
*/
public java.lang.String getExecutionEnvironment() {
return executionEnvironment;
}
/**
* The execution environment being used to host this Task.
* @param executionEnvironment executionEnvironment or {@code null} for none
*/
public GoogleCloudRunV2Task setExecutionEnvironment(java.lang.String executionEnvironment) {
this.executionEnvironment = executionEnvironment;
return this;
}
/**
* Output only. For a deleted resource, the time after which it will be permamently deleted. It is
* only populated as a response to a Delete request.
* @return value or {@code null} for none
*/
public String getExpireTime() {
return expireTime;
}
/**
* Output only. For a deleted resource, the time after which it will be permamently deleted. It is
* only populated as a response to a Delete request.
* @param expireTime expireTime or {@code null} for none
*/
public GoogleCloudRunV2Task setExpireTime(String expireTime) {
this.expireTime = expireTime;
return this;
}
/**
* Output only. A number that monotonically increases every time the user modifies the desired
* state.
* @return value or {@code null} for none
*/
public java.lang.Long getGeneration() {
return generation;
}
/**
* Output only. A number that monotonically increases every time the user modifies the desired
* state.
* @param generation generation or {@code null} for none
*/
public GoogleCloudRunV2Task setGeneration(java.lang.Long generation) {
this.generation = generation;
return this;
}
/**
* Output only. Index of the Task, unique per execution, and beginning at 0.
* @return value or {@code null} for none
*/
public java.lang.Integer getIndex() {
return index;
}
/**
* Output only. Index of the Task, unique per execution, and beginning at 0.
* @param index index or {@code null} for none
*/
public GoogleCloudRunV2Task setIndex(java.lang.Integer index) {
this.index = index;
return this;
}
/**
* Output only. The name of the parent Job.
* @return value or {@code null} for none
*/
public java.lang.String getJob() {
return job;
}
/**
* Output only. The name of the parent Job.
* @param job job or {@code null} for none
*/
public GoogleCloudRunV2Task setJob(java.lang.String job) {
this.job = job;
return this;
}
/**
* Output only. Unstructured key value map that can be used to organize and categorize objects.
* User-provided labels are shared with Google's billing system, so they can be used to filter, or
* break down billing charges by team, component, environment, state, etc. For more information,
* visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or
* https://cloud.google.com/run/docs/configuring/labels
* @return value or {@code null} for none
*/
public java.util.Map getLabels() {
return labels;
}
/**
* Output only. Unstructured key value map that can be used to organize and categorize objects.
* User-provided labels are shared with Google's billing system, so they can be used to filter, or
* break down billing charges by team, component, environment, state, etc. For more information,
* visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or
* https://cloud.google.com/run/docs/configuring/labels
* @param labels labels or {@code null} for none
*/
public GoogleCloudRunV2Task setLabels(java.util.Map labels) {
this.labels = labels;
return this;
}
/**
* Output only. Result of the last attempt of this Task.
* @return value or {@code null} for none
*/
public GoogleCloudRunV2TaskAttemptResult getLastAttemptResult() {
return lastAttemptResult;
}
/**
* Output only. Result of the last attempt of this Task.
* @param lastAttemptResult lastAttemptResult or {@code null} for none
*/
public GoogleCloudRunV2Task setLastAttemptResult(GoogleCloudRunV2TaskAttemptResult lastAttemptResult) {
this.lastAttemptResult = lastAttemptResult;
return this;
}
/**
* Output only. URI where logs for this execution can be found in Cloud Console.
* @return value or {@code null} for none
*/
public java.lang.String getLogUri() {
return logUri;
}
/**
* Output only. URI where logs for this execution can be found in Cloud Console.
* @param logUri logUri or {@code null} for none
*/
public GoogleCloudRunV2Task setLogUri(java.lang.String logUri) {
this.logUri = logUri;
return this;
}
/**
* Number of retries allowed per Task, before marking this Task failed.
* @return value or {@code null} for none
*/
public java.lang.Integer getMaxRetries() {
return maxRetries;
}
/**
* Number of retries allowed per Task, before marking this Task failed.
* @param maxRetries maxRetries or {@code null} for none
*/
public GoogleCloudRunV2Task setMaxRetries(java.lang.Integer maxRetries) {
this.maxRetries = maxRetries;
return this;
}
/**
* Output only. The unique name of this Task.
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* Output only. The unique name of this Task.
* @param name name or {@code null} for none
*/
public GoogleCloudRunV2Task setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* Output only. The generation of this Task. See comments in `Job.reconciling` for additional
* information on reconciliation process in Cloud Run.
* @return value or {@code null} for none
*/
public java.lang.Long getObservedGeneration() {
return observedGeneration;
}
/**
* Output only. The generation of this Task. See comments in `Job.reconciling` for additional
* information on reconciliation process in Cloud Run.
* @param observedGeneration observedGeneration or {@code null} for none
*/
public GoogleCloudRunV2Task setObservedGeneration(java.lang.Long observedGeneration) {
this.observedGeneration = observedGeneration;
return this;
}
/**
* Output only. Indicates whether the resource's reconciliation is still in progress. See comments
* in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
* @return value or {@code null} for none
*/
public java.lang.Boolean getReconciling() {
return reconciling;
}
/**
* Output only. Indicates whether the resource's reconciliation is still in progress. See comments
* in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
* @param reconciling reconciling or {@code null} for none
*/
public GoogleCloudRunV2Task setReconciling(java.lang.Boolean reconciling) {
this.reconciling = reconciling;
return this;
}
/**
* Output only. The number of times this Task was retried. Tasks are retried when they fail up to
* the maxRetries limit.
* @return value or {@code null} for none
*/
public java.lang.Integer getRetried() {
return retried;
}
/**
* Output only. The number of times this Task was retried. Tasks are retried when they fail up to
* the maxRetries limit.
* @param retried retried or {@code null} for none
*/
public GoogleCloudRunV2Task setRetried(java.lang.Integer retried) {
this.retried = retried;
return this;
}
/**
* Output only. Reserved for future use.
* @return value or {@code null} for none
*/
public java.lang.Boolean getSatisfiesPzs() {
return satisfiesPzs;
}
/**
* Output only. Reserved for future use.
* @param satisfiesPzs satisfiesPzs or {@code null} for none
*/
public GoogleCloudRunV2Task setSatisfiesPzs(java.lang.Boolean satisfiesPzs) {
this.satisfiesPzs = satisfiesPzs;
return this;
}
/**
* Output only. Represents time when the task was scheduled to run by the system. It is not
* guaranteed to be set in happens-before order across separate operations.
* @return value or {@code null} for none
*/
public String getScheduledTime() {
return scheduledTime;
}
/**
* Output only. Represents time when the task was scheduled to run by the system. It is not
* guaranteed to be set in happens-before order across separate operations.
* @param scheduledTime scheduledTime or {@code null} for none
*/
public GoogleCloudRunV2Task setScheduledTime(String scheduledTime) {
this.scheduledTime = scheduledTime;
return this;
}
/**
* Email address of the IAM service account associated with the Task of a Job. The service account
* represents the identity of the running task, and determines what permissions the task has. If
* not provided, the task will use the project's default service account.
* @return value or {@code null} for none
*/
public java.lang.String getServiceAccount() {
return serviceAccount;
}
/**
* Email address of the IAM service account associated with the Task of a Job. The service account
* represents the identity of the running task, and determines what permissions the task has. If
* not provided, the task will use the project's default service account.
* @param serviceAccount serviceAccount or {@code null} for none
*/
public GoogleCloudRunV2Task setServiceAccount(java.lang.String serviceAccount) {
this.serviceAccount = serviceAccount;
return this;
}
/**
* Output only. Represents time when the task started to run. It is not guaranteed to be set in
* happens-before order across separate operations.
* @return value or {@code null} for none
*/
public String getStartTime() {
return startTime;
}
/**
* Output only. Represents time when the task started to run. It is not guaranteed to be set in
* happens-before order across separate operations.
* @param startTime startTime or {@code null} for none
*/
public GoogleCloudRunV2Task setStartTime(String startTime) {
this.startTime = startTime;
return this;
}
/**
* Max allowed time duration the Task may be active before the system will actively try to mark it
* failed and kill associated containers. This applies per attempt of a task, meaning each retry
* can run for the full timeout.
* @return value or {@code null} for none
*/
public String getTimeout() {
return timeout;
}
/**
* Max allowed time duration the Task may be active before the system will actively try to mark it
* failed and kill associated containers. This applies per attempt of a task, meaning each retry
* can run for the full timeout.
* @param timeout timeout or {@code null} for none
*/
public GoogleCloudRunV2Task setTimeout(String timeout) {
this.timeout = timeout;
return this;
}
/**
* Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and
* guaranteed to remain unchanged until the resource is deleted.
* @return value or {@code null} for none
*/
public java.lang.String getUid() {
return uid;
}
/**
* Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and
* guaranteed to remain unchanged until the resource is deleted.
* @param uid uid or {@code null} for none
*/
public GoogleCloudRunV2Task setUid(java.lang.String uid) {
this.uid = uid;
return this;
}
/**
* Output only. The last-modified time.
* @return value or {@code null} for none
*/
public String getUpdateTime() {
return updateTime;
}
/**
* Output only. The last-modified time.
* @param updateTime updateTime or {@code null} for none
*/
public GoogleCloudRunV2Task setUpdateTime(String updateTime) {
this.updateTime = updateTime;
return this;
}
/**
* A list of Volumes to make available to containers.
* @return value or {@code null} for none
*/
public java.util.List getVolumes() {
return volumes;
}
/**
* A list of Volumes to make available to containers.
* @param volumes volumes or {@code null} for none
*/
public GoogleCloudRunV2Task setVolumes(java.util.List volumes) {
this.volumes = volumes;
return this;
}
/**
* Output only. VPC Access configuration to use for this Task. For more information, visit
* https://cloud.google.com/run/docs/configuring/connecting-vpc.
* @return value or {@code null} for none
*/
public GoogleCloudRunV2VpcAccess getVpcAccess() {
return vpcAccess;
}
/**
* Output only. VPC Access configuration to use for this Task. For more information, visit
* https://cloud.google.com/run/docs/configuring/connecting-vpc.
* @param vpcAccess vpcAccess or {@code null} for none
*/
public GoogleCloudRunV2Task setVpcAccess(GoogleCloudRunV2VpcAccess vpcAccess) {
this.vpcAccess = vpcAccess;
return this;
}
@Override
public GoogleCloudRunV2Task set(String fieldName, Object value) {
return (GoogleCloudRunV2Task) super.set(fieldName, value);
}
@Override
public GoogleCloudRunV2Task clone() {
return (GoogleCloudRunV2Task) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy