Class CreateKeyRequest (0.44.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
Type Description
int

KEY_ID_FIELD_NUMBER

public static final int KEY_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateKeyRequest getDefaultInstance()
Returns
Type Description
CreateKeyRequest

getDescriptor()

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

newBuilder()

public static CreateKeyRequest.Builder newBuilder()
Returns
Type Description
CreateKeyRequest.Builder

newBuilder(CreateKeyRequest prototype)

public static CreateKeyRequest.Builder newBuilder(CreateKeyRequest prototype)
Parameter
Name Description
prototype CreateKeyRequest
Returns
Type Description
CreateKeyRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateKeyRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateKeyRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateKeyRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateKeyRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateKeyRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateKeyRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateKeyRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateKeyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateKeyRequest> parser()
Returns
Type Description
Parser<CreateKeyRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateKeyRequest getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
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.

getParserForType()

public Parser<CreateKeyRequest> getParserForType()
Returns
Type Description
Parser<CreateKeyRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

Whether the key field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateKeyRequest.Builder newBuilderForType()
Returns
Type Description
CreateKeyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateKeyRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateKeyRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateKeyRequest.Builder toBuilder()
Returns
Type Description
CreateKeyRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException