Class CreateKeyRequest.Builder (0.40.0)

Version 0.40.0

• 0.49.0 (latest)
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.2

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateKeyRequest.Builder

Implements

CreateKeyRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public CreateKeyRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CreateKeyRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public CreateKeyRequest getDefaultInstanceForType()

Returns
Type	Description
CreateKeyRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CreateKeyRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CreateKeyRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateKeyRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CreateKeyRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)