com.google.api.services.cloudfunctions.v2.model.Function 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.cloudfunctions.v2.model;
/**
* Describes a Cloud Function that contains user computation executed in response to an event. It
* encapsulates function and trigger configurations.
*
* 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 Functions 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 Function extends com.google.api.client.json.GenericJson {
/**
* Describes the Build step of the function that builds a container from the given source.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private BuildConfig buildConfig;
/**
* User-provided description of a function.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String description;
/**
* Describe whether the function is 1st Gen or 2nd Gen.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String environment;
/**
* An Eventarc trigger managed by Google Cloud Functions that fires events in response to a
* condition in another service.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EventTrigger eventTrigger;
/**
* [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt
* function resources. It must match the pattern
* `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kmsKeyName;
/**
* Labels associated with this Cloud Function.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map labels;
/**
* A user-defined name of the function. Function names must be unique globally and match pattern
* `projects/locations/functions`
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* Output only. Reserved for future use.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean satisfiesPzs;
/**
* Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private ServiceConfig serviceConfig;
/**
* Output only. State of the function.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String state;
/**
* Output only. State Messages for this Cloud Function.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List stateMessages;
/**
* Output only. The last update timestamp of a Cloud Function.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String updateTime;
/**
* Output only. The deployed url for the function.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String url;
/**
* Describes the Build step of the function that builds a container from the given source.
* @return value or {@code null} for none
*/
public BuildConfig getBuildConfig() {
return buildConfig;
}
/**
* Describes the Build step of the function that builds a container from the given source.
* @param buildConfig buildConfig or {@code null} for none
*/
public Function setBuildConfig(BuildConfig buildConfig) {
this.buildConfig = buildConfig;
return this;
}
/**
* User-provided description of a function.
* @return value or {@code null} for none
*/
public java.lang.String getDescription() {
return description;
}
/**
* User-provided description of a function.
* @param description description or {@code null} for none
*/
public Function setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* Describe whether the function is 1st Gen or 2nd Gen.
* @return value or {@code null} for none
*/
public java.lang.String getEnvironment() {
return environment;
}
/**
* Describe whether the function is 1st Gen or 2nd Gen.
* @param environment environment or {@code null} for none
*/
public Function setEnvironment(java.lang.String environment) {
this.environment = environment;
return this;
}
/**
* An Eventarc trigger managed by Google Cloud Functions that fires events in response to a
* condition in another service.
* @return value or {@code null} for none
*/
public EventTrigger getEventTrigger() {
return eventTrigger;
}
/**
* An Eventarc trigger managed by Google Cloud Functions that fires events in response to a
* condition in another service.
* @param eventTrigger eventTrigger or {@code null} for none
*/
public Function setEventTrigger(EventTrigger eventTrigger) {
this.eventTrigger = eventTrigger;
return this;
}
/**
* [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt
* function resources. It must match the pattern
* `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
* @return value or {@code null} for none
*/
public java.lang.String getKmsKeyName() {
return kmsKeyName;
}
/**
* [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt
* function resources. It must match the pattern
* `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
* @param kmsKeyName kmsKeyName or {@code null} for none
*/
public Function setKmsKeyName(java.lang.String kmsKeyName) {
this.kmsKeyName = kmsKeyName;
return this;
}
/**
* Labels associated with this Cloud Function.
* @return value or {@code null} for none
*/
public java.util.Map getLabels() {
return labels;
}
/**
* Labels associated with this Cloud Function.
* @param labels labels or {@code null} for none
*/
public Function setLabels(java.util.Map labels) {
this.labels = labels;
return this;
}
/**
* A user-defined name of the function. Function names must be unique globally and match pattern
* `projects/locations/functions`
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* A user-defined name of the function. Function names must be unique globally and match pattern
* `projects/locations/functions`
* @param name name or {@code null} for none
*/
public Function setName(java.lang.String name) {
this.name = name;
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 Function setSatisfiesPzs(java.lang.Boolean satisfiesPzs) {
this.satisfiesPzs = satisfiesPzs;
return this;
}
/**
* Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
* @return value or {@code null} for none
*/
public ServiceConfig getServiceConfig() {
return serviceConfig;
}
/**
* Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
* @param serviceConfig serviceConfig or {@code null} for none
*/
public Function setServiceConfig(ServiceConfig serviceConfig) {
this.serviceConfig = serviceConfig;
return this;
}
/**
* Output only. State of the function.
* @return value or {@code null} for none
*/
public java.lang.String getState() {
return state;
}
/**
* Output only. State of the function.
* @param state state or {@code null} for none
*/
public Function setState(java.lang.String state) {
this.state = state;
return this;
}
/**
* Output only. State Messages for this Cloud Function.
* @return value or {@code null} for none
*/
public java.util.List getStateMessages() {
return stateMessages;
}
/**
* Output only. State Messages for this Cloud Function.
* @param stateMessages stateMessages or {@code null} for none
*/
public Function setStateMessages(java.util.List stateMessages) {
this.stateMessages = stateMessages;
return this;
}
/**
* Output only. The last update timestamp of a Cloud Function.
* @return value or {@code null} for none
*/
public String getUpdateTime() {
return updateTime;
}
/**
* Output only. The last update timestamp of a Cloud Function.
* @param updateTime updateTime or {@code null} for none
*/
public Function setUpdateTime(String updateTime) {
this.updateTime = updateTime;
return this;
}
/**
* Output only. The deployed url for the function.
* @return value or {@code null} for none
*/
public java.lang.String getUrl() {
return url;
}
/**
* Output only. The deployed url for the function.
* @param url url or {@code null} for none
*/
public Function setUrl(java.lang.String url) {
this.url = url;
return this;
}
@Override
public Function set(String fieldName, Object value) {
return (Function) super.set(fieldName, value);
}
@Override
public Function clone() {
return (Function) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy