Represents a CreateDatabaseRequest.
Package
@google-cloud/spannerConstructors
(constructor)(properties)
constructor(properties?: google.spanner.admin.database.v1.ICreateDatabaseRequest);
Constructs a new CreateDatabaseRequest.
Parameter | |
---|---|
Name | Description |
properties |
ICreateDatabaseRequest
Properties to set |
Properties
createStatement
public createStatement: string;
CreateDatabaseRequest createStatement.
databaseDialect
public databaseDialect: (google.spanner.admin.database.v1.DatabaseDialect|keyof typeof google.spanner.admin.database.v1.DatabaseDialect);
CreateDatabaseRequest databaseDialect.
encryptionConfig
public encryptionConfig?: (google.spanner.admin.database.v1.IEncryptionConfig|null);
CreateDatabaseRequest encryptionConfig.
extraStatements
public extraStatements: string[];
CreateDatabaseRequest extraStatements.
parent
public parent: string;
CreateDatabaseRequest parent.
Methods
create(properties)
public static create(properties?: google.spanner.admin.database.v1.ICreateDatabaseRequest): google.spanner.admin.database.v1.CreateDatabaseRequest;
Creates a new CreateDatabaseRequest instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ICreateDatabaseRequest
Properties to set |
Returns | |
---|---|
Type | Description |
CreateDatabaseRequest | CreateDatabaseRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.admin.database.v1.CreateDatabaseRequest;
Decodes a CreateDatabaseRequest message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
CreateDatabaseRequest | CreateDatabaseRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.admin.database.v1.CreateDatabaseRequest;
Decodes a CreateDatabaseRequest message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
CreateDatabaseRequest | CreateDatabaseRequest |
encode(message, writer)
public static encode(message: google.spanner.admin.database.v1.ICreateDatabaseRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified CreateDatabaseRequest message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ICreateDatabaseRequest
CreateDatabaseRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.spanner.admin.database.v1.ICreateDatabaseRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified CreateDatabaseRequest message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ICreateDatabaseRequest
CreateDatabaseRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.spanner.admin.database.v1.CreateDatabaseRequest;
Creates a CreateDatabaseRequest message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
CreateDatabaseRequest | CreateDatabaseRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for CreateDatabaseRequest
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this CreateDatabaseRequest to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.spanner.admin.database.v1.CreateDatabaseRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a CreateDatabaseRequest message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
CreateDatabaseRequest
CreateDatabaseRequest |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a CreateDatabaseRequest message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|