Class protos.google.api.GoSettings (4.5.0)
Represents a GoSettings.
Package
@google-cloud/kmsConstructors
(constructor)(properties)
constructor(properties?:google.api.IGoSettings);Constructs a new GoSettings.
| Parameter | |
|---|---|
| Name | Description |
properties | IGoSettingsProperties to set |
Properties
common
publiccommon?:(google.api.ICommonLanguageSettings|null);GoSettings common.
Methods
create(properties)
publicstaticcreate(properties?:google.api.IGoSettings):google.api.GoSettings;Creates a new GoSettings instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IGoSettingsProperties to set |
| Returns | |
|---|---|
| Type | Description |
GoSettings | GoSettings instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.api.GoSettings;Decodes a GoSettings message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
GoSettings | GoSettings |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.api.GoSettings;Decodes a GoSettings message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
GoSettings | GoSettings |
encode(message, writer)
publicstaticencode(message:google.api.IGoSettings,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified GoSettings message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IGoSettingsGoSettings message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.api.IGoSettings,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified GoSettings message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IGoSettingsGoSettings message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.api.GoSettings;Creates a GoSettings 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 |
GoSettings | GoSettings |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for GoSettings
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this GoSettings to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(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.
| Parameters | |
|---|---|
| Name | Description |
message | GoSettingsGoSettings |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a GoSettings message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.