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