Function.Builder (proto-google-cloud-functions-v2 2.32.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>
    - - com.google.cloud.functions.v2.Function.Builder

All Implemented Interfaces:: FunctionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: Function

public static final class Function.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>
implements FunctionOrBuilder

 Describes a Cloud Function that contains user computation executed in
 response to an event. It encapsulates function and trigger configurations.

Protobuf type google.cloud.functions.v2.Function

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Function.Builder`	`addAllStateMessages(Iterable<? extends StateMessage> values)` Output only.
`Function.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Function.Builder`	`addStateMessages(int index, StateMessage.Builder builderForValue)` Output only.
`Function.Builder`	`addStateMessages(int index, StateMessage value)` Output only.
`Function.Builder`	`addStateMessages(StateMessage.Builder builderForValue)` Output only.
`Function.Builder`	`addStateMessages(StateMessage value)` Output only.
`StateMessage.Builder`	`addStateMessagesBuilder()` Output only.
`StateMessage.Builder`	`addStateMessagesBuilder(int index)` Output only.
`Function`	`build()`
`Function`	`buildPartial()`
`Function.Builder`	`clear()`
`Function.Builder`	`clearBuildConfig()` Describes the Build step of the function that builds a container from the given source.
`Function.Builder`	`clearDescription()` User-provided description of a function.
`Function.Builder`	`clearEnvironment()` Describe whether the function is 1st Gen or 2nd Gen.
`Function.Builder`	`clearEventTrigger()` An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
`Function.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Function.Builder`	`clearKmsKeyName()` [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
`Function.Builder`	`clearLabels()`
`Function.Builder`	`clearName()` A user-defined name of the function.
`Function.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Function.Builder`	`clearServiceConfig()` Describes the Service being deployed.
`Function.Builder`	`clearState()` Output only.
`Function.Builder`	`clearStateMessages()` Output only.
`Function.Builder`	`clearUpdateTime()` Output only.
`Function.Builder`	`clearUrl()` Output only.
`Function.Builder`	`clone()`
`boolean`	`containsLabels(String key)` Labels associated with this Cloud Function.
`BuildConfig`	`getBuildConfig()` Describes the Build step of the function that builds a container from the given source.
`BuildConfig.Builder`	`getBuildConfigBuilder()` Describes the Build step of the function that builds a container from the given source.
`BuildConfigOrBuilder`	`getBuildConfigOrBuilder()` Describes the Build step of the function that builds a container from the given source.
`Function`	`getDefaultInstanceForType()`
`String`	`getDescription()` User-provided description of a function.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` User-provided description of a function.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`Environment`	`getEnvironment()` Describe whether the function is 1st Gen or 2nd Gen.
`int`	`getEnvironmentValue()` Describe whether the function is 1st Gen or 2nd Gen.
`EventTrigger`	`getEventTrigger()` An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
`EventTrigger.Builder`	`getEventTriggerBuilder()` An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
`EventTriggerOrBuilder`	`getEventTriggerOrBuilder()` An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
`String`	`getKmsKeyName()` [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
`com.google.protobuf.ByteString`	`getKmsKeyNameBytes()` [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Labels associated with this Cloud Function.
`Map<String,String>`	`getLabelsMap()` Labels associated with this Cloud Function.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Labels associated with this Cloud Function.
`String`	`getLabelsOrThrow(String key)` Labels associated with this Cloud Function.
`Map<String,String>`	`getMutableLabels()` Deprecated.
`String`	`getName()` A user-defined name of the function.
`com.google.protobuf.ByteString`	`getNameBytes()` A user-defined name of the function.
`ServiceConfig`	`getServiceConfig()` Describes the Service being deployed.
`ServiceConfig.Builder`	`getServiceConfigBuilder()` Describes the Service being deployed.
`ServiceConfigOrBuilder`	`getServiceConfigOrBuilder()` Describes the Service being deployed.
`Function.State`	`getState()` Output only.
`StateMessage`	`getStateMessages(int index)` Output only.
`StateMessage.Builder`	`getStateMessagesBuilder(int index)` Output only.
`List<StateMessage.Builder>`	`getStateMessagesBuilderList()` Output only.
`int`	`getStateMessagesCount()` Output only.
`List<StateMessage>`	`getStateMessagesList()` Output only.
`StateMessageOrBuilder`	`getStateMessagesOrBuilder(int index)` Output only.
`List<? extends StateMessageOrBuilder>`	`getStateMessagesOrBuilderList()` Output only.
`int`	`getStateValue()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.Timestamp.Builder`	`getUpdateTimeBuilder()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`String`	`getUrl()` Output only.
`com.google.protobuf.ByteString`	`getUrlBytes()` Output only.
`boolean`	`hasBuildConfig()` Describes the Build step of the function that builds a container from the given source.
`boolean`	`hasEventTrigger()` An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
`boolean`	`hasServiceConfig()` Describes the Service being deployed.
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`Function.Builder`	`mergeBuildConfig(BuildConfig value)` Describes the Build step of the function that builds a container from the given source.
`Function.Builder`	`mergeEventTrigger(EventTrigger value)` An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
`Function.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Function.Builder`	`mergeFrom(Function other)`
`Function.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Function.Builder`	`mergeServiceConfig(ServiceConfig value)` Describes the Service being deployed.
`Function.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Function.Builder`	`mergeUpdateTime(com.google.protobuf.Timestamp value)` Output only.
`Function.Builder`	`putAllLabels(Map<String,String> values)` Labels associated with this Cloud Function.
`Function.Builder`	`putLabels(String key, String value)` Labels associated with this Cloud Function.
`Function.Builder`	`removeLabels(String key)` Labels associated with this Cloud Function.
`Function.Builder`	`removeStateMessages(int index)` Output only.
`Function.Builder`	`setBuildConfig(BuildConfig.Builder builderForValue)` Describes the Build step of the function that builds a container from the given source.
`Function.Builder`	`setBuildConfig(BuildConfig value)` Describes the Build step of the function that builds a container from the given source.
`Function.Builder`	`setDescription(String value)` User-provided description of a function.
`Function.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` User-provided description of a function.
`Function.Builder`	`setEnvironment(Environment value)` Describe whether the function is 1st Gen or 2nd Gen.
`Function.Builder`	`setEnvironmentValue(int value)` Describe whether the function is 1st Gen or 2nd Gen.
`Function.Builder`	`setEventTrigger(EventTrigger.Builder builderForValue)` An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
`Function.Builder`	`setEventTrigger(EventTrigger value)` An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
`Function.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Function.Builder`	`setKmsKeyName(String value)` [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
`Function.Builder`	`setKmsKeyNameBytes(com.google.protobuf.ByteString value)` [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
`Function.Builder`	`setName(String value)` A user-defined name of the function.
`Function.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` A user-defined name of the function.
`Function.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Function.Builder`	`setServiceConfig(ServiceConfig.Builder builderForValue)` Describes the Service being deployed.
`Function.Builder`	`setServiceConfig(ServiceConfig value)` Describes the Service being deployed.
`Function.Builder`	`setState(Function.State value)` Output only.
`Function.Builder`	`setStateMessages(int index, StateMessage.Builder builderForValue)` Output only.
`Function.Builder`	`setStateMessages(int index, StateMessage value)` Output only.
`Function.Builder`	`setStateValue(int value)` Output only.
`Function.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Function.Builder`	`setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)` Output only.
`Function.Builder`	`setUpdateTime(com.google.protobuf.Timestamp value)` Output only.
`Function.Builder`	`setUrl(String value)` Output only.
`Function.Builder`	`setUrlBytes(com.google.protobuf.ByteString value)` Output only.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

internalGetMutableMapField
```
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
```
Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

clear
```
public Function.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

getDefaultInstanceForType
```
public Function getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Function build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Function buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Function.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

setField

public Function.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

clearField
```
public Function.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

clearOneof
```
public Function.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

setRepeatedField

public Function.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

addRepeatedField

public Function.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

mergeFrom
```
public Function.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Function.Builder>

mergeFrom

public Function.Builder mergeFrom(Function other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Function.Builder>

mergeFrom
```
public Function.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Function.Builder>

Throws:

IOException

getName

public String getName()

 A user-defined name of the function. Function names must be unique
 globally and match pattern `projects/*/locations/*/functions/*`

string name = 1;

Specified by:: getName in interface FunctionOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 A user-defined name of the function. Function names must be unique
 globally and match pattern `projects/*/locations/*/functions/*`

string name = 1;

Specified by:: getNameBytes in interface FunctionOrBuilder
Returns:: The bytes for name.

setName

public Function.Builder setName(String value)

 A user-defined name of the function. Function names must be unique
 globally and match pattern `projects/*/locations/*/functions/*`

string name = 1;

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public Function.Builder clearName()

 A user-defined name of the function. Function names must be unique
 globally and match pattern `projects/*/locations/*/functions/*`

string name = 1;

Returns:: This builder for chaining.

setNameBytes

public Function.Builder setNameBytes(com.google.protobuf.ByteString value)

 A user-defined name of the function. Function names must be unique
 globally and match pattern `projects/*/locations/*/functions/*`

string name = 1;

Parameters:: value - The bytes for name to set.
Returns:: This builder for chaining.

getDescription
```
public String getDescription()
```
```
 User-provided description of a function.
 
```
string description = 2;
Specified by:

getDescription in interface FunctionOrBuilder

Returns:

The description.

getDescriptionBytes
```
public com.google.protobuf.ByteString getDescriptionBytes()
```
```
 User-provided description of a function.
 
```
string description = 2;
Specified by:

getDescriptionBytes in interface FunctionOrBuilder

Returns:

The bytes for description.

setDescription
```
public Function.Builder setDescription(String value)
```
```
 User-provided description of a function.
 
```
string description = 2;
Parameters:

value - The description to set.

Returns:

This builder for chaining.

clearDescription

public Function.Builder clearDescription()

 User-provided description of a function.

string description = 2;

Returns:: This builder for chaining.

setDescriptionBytes

public Function.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 User-provided description of a function.

string description = 2;

Parameters:: value - The bytes for description to set.
Returns:: This builder for chaining.

hasBuildConfig
```
public boolean hasBuildConfig()
```
```
 Describes the Build step of the function that builds a container from the
 given source.
 
```
.google.cloud.functions.v2.BuildConfig build_config = 3;
Specified by:

hasBuildConfig in interface FunctionOrBuilder

Returns:

Whether the buildConfig field is set.

getBuildConfig
```
public BuildConfig getBuildConfig()
```
```
 Describes the Build step of the function that builds a container from the
 given source.
 
```
.google.cloud.functions.v2.BuildConfig build_config = 3;
Specified by:

getBuildConfig in interface FunctionOrBuilder

Returns:

The buildConfig.

setBuildConfig

public Function.Builder setBuildConfig(BuildConfig value)

 Describes the Build step of the function that builds a container from the
 given source.

.google.cloud.functions.v2.BuildConfig build_config = 3;

setBuildConfig

public Function.Builder setBuildConfig(BuildConfig.Builder builderForValue)

 Describes the Build step of the function that builds a container from the
 given source.

.google.cloud.functions.v2.BuildConfig build_config = 3;

mergeBuildConfig

public Function.Builder mergeBuildConfig(BuildConfig value)

 Describes the Build step of the function that builds a container from the
 given source.

.google.cloud.functions.v2.BuildConfig build_config = 3;

clearBuildConfig

public Function.Builder clearBuildConfig()

 Describes the Build step of the function that builds a container from the
 given source.

.google.cloud.functions.v2.BuildConfig build_config = 3;

getBuildConfigBuilder

public BuildConfig.Builder getBuildConfigBuilder()

 Describes the Build step of the function that builds a container from the
 given source.

.google.cloud.functions.v2.BuildConfig build_config = 3;

getBuildConfigOrBuilder

public BuildConfigOrBuilder getBuildConfigOrBuilder()

 Describes the Build step of the function that builds a container from the
 given source.

.google.cloud.functions.v2.BuildConfig build_config = 3;

Specified by:: getBuildConfigOrBuilder in interface FunctionOrBuilder

hasServiceConfig
```
public boolean hasServiceConfig()
```
```
 Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).
 
```
.google.cloud.functions.v2.ServiceConfig service_config = 4;
Specified by:

hasServiceConfig in interface FunctionOrBuilder

Returns:

Whether the serviceConfig field is set.

getServiceConfig
```
public ServiceConfig getServiceConfig()
```
```
 Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).
 
```
.google.cloud.functions.v2.ServiceConfig service_config = 4;
Specified by:

getServiceConfig in interface FunctionOrBuilder

Returns:

The serviceConfig.

setServiceConfig

public Function.Builder setServiceConfig(ServiceConfig value)

 Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).

.google.cloud.functions.v2.ServiceConfig service_config = 4;

setServiceConfig

public Function.Builder setServiceConfig(ServiceConfig.Builder builderForValue)

 Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).

.google.cloud.functions.v2.ServiceConfig service_config = 4;

mergeServiceConfig

public Function.Builder mergeServiceConfig(ServiceConfig value)

 Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).

.google.cloud.functions.v2.ServiceConfig service_config = 4;

clearServiceConfig

public Function.Builder clearServiceConfig()

 Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).

.google.cloud.functions.v2.ServiceConfig service_config = 4;

getServiceConfigBuilder

public ServiceConfig.Builder getServiceConfigBuilder()

 Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).

.google.cloud.functions.v2.ServiceConfig service_config = 4;

getServiceConfigOrBuilder

public ServiceConfigOrBuilder getServiceConfigOrBuilder()

 Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).

.google.cloud.functions.v2.ServiceConfig service_config = 4;

Specified by:: getServiceConfigOrBuilder in interface FunctionOrBuilder

hasEventTrigger
```
public boolean hasEventTrigger()
```
```
 An Eventarc trigger managed by Google Cloud Functions that fires events in
 response to a condition in another service.
 
```
.google.cloud.functions.v2.EventTrigger event_trigger = 5;
Specified by:

hasEventTrigger in interface FunctionOrBuilder

Returns:

Whether the eventTrigger field is set.