Class GenerateUploadUrlRequest.Builder (2.53.0)

public static final class GenerateUploadUrlRequest.Builder extends GeneratedMessageV3.Builder<GenerateUploadUrlRequest.Builder> implements GenerateUploadUrlRequestOrBuilder

Request of GenerateSourceUploadUrl method.

Protobuf type google.cloud.functions.v2alpha.GenerateUploadUrlRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerateUploadUrlRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

build()

public GenerateUploadUrlRequest build()
Returns
Type Description
GenerateUploadUrlRequest

buildPartial()

public GenerateUploadUrlRequest buildPartial()
Returns
Type Description
GenerateUploadUrlRequest

clear()

public GenerateUploadUrlRequest.Builder clear()
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

clearEnvironment()

public GenerateUploadUrlRequest.Builder clearEnvironment()

The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated.

.google.cloud.functions.v2alpha.Environment environment = 3;

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GenerateUploadUrlRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

clearKmsKeyName()

public GenerateUploadUrlRequest.Builder clearKmsKeyName()

[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

string kms_key_name = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerateUploadUrlRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

clearParent()

public GenerateUploadUrlRequest.Builder clearParent()

Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format projects/*/locations/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

clone()

public GenerateUploadUrlRequest.Builder clone()
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

getDefaultInstanceForType()

public GenerateUploadUrlRequest getDefaultInstanceForType()
Returns
Type Description
GenerateUploadUrlRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnvironment()

public Environment getEnvironment()

The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated.

.google.cloud.functions.v2alpha.Environment environment = 3;

Returns
Type Description
Environment

The environment.

getEnvironmentValue()

public int getEnvironmentValue()

The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated.

.google.cloud.functions.v2alpha.Environment environment = 3;

Returns
Type Description
int

The enum numeric value on the wire for environment.

getKmsKeyName()

public String getKmsKeyName()

[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

string kms_key_name = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

string kms_key_name = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getParent()

public String getParent()

Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format projects/*/locations/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format projects/*/locations/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GenerateUploadUrlRequest other)

public GenerateUploadUrlRequest.Builder mergeFrom(GenerateUploadUrlRequest other)
Parameter
Name Description
other GenerateUploadUrlRequest
Returns
Type Description
GenerateUploadUrlRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerateUploadUrlRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GenerateUploadUrlRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateUploadUrlRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

setEnvironment(Environment value)

public GenerateUploadUrlRequest.Builder setEnvironment(Environment value)

The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated.

.google.cloud.functions.v2alpha.Environment environment = 3;

Parameter
Name Description
value Environment

The environment to set.

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

setEnvironmentValue(int value)

public GenerateUploadUrlRequest.Builder setEnvironmentValue(int value)

The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated.

.google.cloud.functions.v2alpha.Environment environment = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for environment to set.

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GenerateUploadUrlRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

setKmsKeyName(String value)

public GenerateUploadUrlRequest.Builder setKmsKeyName(String value)

[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

string kms_key_name = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKeyName to set.

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public GenerateUploadUrlRequest.Builder setKmsKeyNameBytes(ByteString value)

[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

string kms_key_name = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

setParent(String value)

public GenerateUploadUrlRequest.Builder setParent(String value)

Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format projects/*/locations/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public GenerateUploadUrlRequest.Builder setParentBytes(ByteString value)

Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format projects/*/locations/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
GenerateUploadUrlRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GenerateUploadUrlRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerateUploadUrlRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerateUploadUrlRequest.Builder
Overrides