Class CreateKeyRequest (0.38.0)

public final class CreateKeyRequest extends GeneratedMessageV3 implements CreateKeyRequestOrBuilder

Request message for CreateKey method.

Protobuf type google.api.apikeys.v2.CreateKeyRequest

Static Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
TypeDescription
int

KEY_ID_FIELD_NUMBER

public static final int KEY_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateKeyRequest getDefaultInstance()
Returns
TypeDescription
CreateKeyRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateKeyRequest.Builder newBuilder()
Returns
TypeDescription
CreateKeyRequest.Builder

newBuilder(CreateKeyRequest prototype)

public static CreateKeyRequest.Builder newBuilder(CreateKeyRequest prototype)
Parameter
NameDescription
prototypeCreateKeyRequest
Returns
TypeDescription
CreateKeyRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateKeyRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateKeyRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateKeyRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateKeyRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateKeyRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateKeyRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateKeyRequest> parser()
Returns
TypeDescription
Parser<CreateKeyRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateKeyRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateKeyRequest

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
TypeDescription
Key

The key.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateKeyRequest> getParserForType()
Returns
TypeDescription
Parser<CreateKeyRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
boolean

Whether the key field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateKeyRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateKeyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateKeyRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateKeyRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateKeyRequest.Builder toBuilder()
Returns
TypeDescription
CreateKeyRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException