Class CreateKeyRequest.Builder (0.43.0)

public static final class CreateKeyRequest.Builder extends GeneratedMessageV3.Builder<CreateKeyRequest.Builder> implements CreateKeyRequestOrBuilder

Request message for CreateKey method.

Protobuf type google.api.apikeys.v2.CreateKeyRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CreateKeyRequest build()
Returns
Type Description
CreateKeyRequest

buildPartial()

public CreateKeyRequest buildPartial()
Returns
Type Description
CreateKeyRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearKey()

public CreateKeyRequest.Builder clearKey()

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateKeyRequest.Builder

clearKeyId()

public CreateKeyRequest.Builder clearKeyId()

User specified key id (optional). If specified, it will become the final component of the key resource name.

The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: a-z?.

The id must NOT be a UUID-like string.

string key_id = 3;

Returns
Type Description
CreateKeyRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public CreateKeyRequest.Builder clearParent()

Required. The project in which the API key is created.

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

Returns
Type Description
CreateKeyRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CreateKeyRequest getDefaultInstanceForType()
Returns
Type Description
CreateKeyRequest

getDescriptorForType()

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

getKey()

public Key getKey()

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Key

The key.

getKeyBuilder()

public Key.Builder getKeyBuilder()

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Key.Builder

getKeyId()

public String getKeyId()

User specified key id (optional). If specified, it will become the final component of the key resource name.

The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: a-z?.

The id must NOT be a UUID-like string.

string key_id = 3;

Returns
Type Description
String

The keyId.

getKeyIdBytes()

public ByteString getKeyIdBytes()

User specified key id (optional). If specified, it will become the final component of the key resource name.

The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: a-z?.

The id must NOT be a UUID-like string.

string key_id = 3;

Returns
Type Description
ByteString

The bytes for keyId.

getKeyOrBuilder()

public KeyOrBuilder getKeyOrBuilder()

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
KeyOrBuilder

getParent()

public String getParent()

Required. The project in which the API key is created.

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 in which the API key is created.

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

Returns
Type Description
ByteString

The bytes for parent.

hasKey()

public boolean hasKey()

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the key field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreateKeyRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeKey(Key value)

public CreateKeyRequest.Builder mergeKey(Key value)

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Key
Returns
Type Description
CreateKeyRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setKey(Key value)

public CreateKeyRequest.Builder setKey(Key value)

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Key
Returns
Type Description
CreateKeyRequest.Builder

setKey(Key.Builder builderForValue)

public CreateKeyRequest.Builder setKey(Key.Builder builderForValue)

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Key.Builder
Returns
Type Description
CreateKeyRequest.Builder

setKeyId(String value)

public CreateKeyRequest.Builder setKeyId(String value)

User specified key id (optional). If specified, it will become the final component of the key resource name.

The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: a-z?.

The id must NOT be a UUID-like string.

string key_id = 3;

Parameter
Name Description
value String

The keyId to set.

Returns
Type Description
CreateKeyRequest.Builder

This builder for chaining.

setKeyIdBytes(ByteString value)

public CreateKeyRequest.Builder setKeyIdBytes(ByteString value)

User specified key id (optional). If specified, it will become the final component of the key resource name.

The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: a-z?.

The id must NOT be a UUID-like string.

string key_id = 3;

Parameter
Name Description
value ByteString

The bytes for keyId to set.

Returns
Type Description
CreateKeyRequest.Builder

This builder for chaining.

setParent(String value)

public CreateKeyRequest.Builder setParent(String value)

Required. The project in which the API key is created.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateKeyRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateKeyRequest.Builder setParentBytes(ByteString value)

Required. The project in which the API key is created.

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
CreateKeyRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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