Represents a RestoreConfig.
Package
@google-cloud/gke-backupConstructors
(constructor)(properties)
constructor(properties?: google.cloud.gkebackup.v1.IRestoreConfig);
Constructs a new RestoreConfig.
Parameter | |
---|---|
Name | Description |
properties |
IRestoreConfig
Properties to set |
Properties
allNamespaces
public allNamespaces?: (boolean|null);
RestoreConfig allNamespaces.
clusterResourceConflictPolicy
public clusterResourceConflictPolicy: (google.cloud.gkebackup.v1.RestoreConfig.ClusterResourceConflictPolicy|keyof typeof google.cloud.gkebackup.v1.RestoreConfig.ClusterResourceConflictPolicy);
RestoreConfig clusterResourceConflictPolicy.
clusterResourceRestoreScope
public clusterResourceRestoreScope?: (google.cloud.gkebackup.v1.RestoreConfig.IClusterResourceRestoreScope|null);
RestoreConfig clusterResourceRestoreScope.
excludedNamespaces
public excludedNamespaces?: (google.cloud.gkebackup.v1.INamespaces|null);
RestoreConfig excludedNamespaces.
namespacedResourceRestoreMode
public namespacedResourceRestoreMode: (google.cloud.gkebackup.v1.RestoreConfig.NamespacedResourceRestoreMode|keyof typeof google.cloud.gkebackup.v1.RestoreConfig.NamespacedResourceRestoreMode);
RestoreConfig namespacedResourceRestoreMode.
namespacedResourceRestoreScope
public namespacedResourceRestoreScope?: ("allNamespaces"|"selectedNamespaces"|"selectedApplications"|"noNamespaces"|"excludedNamespaces");
RestoreConfig namespacedResourceRestoreScope.
noNamespaces
public noNamespaces?: (boolean|null);
RestoreConfig noNamespaces.
selectedApplications
public selectedApplications?: (google.cloud.gkebackup.v1.INamespacedNames|null);
RestoreConfig selectedApplications.
selectedNamespaces
public selectedNamespaces?: (google.cloud.gkebackup.v1.INamespaces|null);
RestoreConfig selectedNamespaces.
substitutionRules
public substitutionRules: google.cloud.gkebackup.v1.RestoreConfig.ISubstitutionRule[];
RestoreConfig substitutionRules.
transformationRules
public transformationRules: google.cloud.gkebackup.v1.RestoreConfig.ITransformationRule[];
RestoreConfig transformationRules.
volumeDataRestorePolicy
public volumeDataRestorePolicy: (google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicy|keyof typeof google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicy);
RestoreConfig volumeDataRestorePolicy.
Methods
create(properties)
public static create(properties?: google.cloud.gkebackup.v1.IRestoreConfig): google.cloud.gkebackup.v1.RestoreConfig;
Creates a new RestoreConfig instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IRestoreConfig
Properties to set |
Returns | |
---|---|
Type | Description |
RestoreConfig | RestoreConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gkebackup.v1.RestoreConfig;
Decodes a RestoreConfig 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 |
RestoreConfig | RestoreConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkebackup.v1.RestoreConfig;
Decodes a RestoreConfig message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
RestoreConfig | RestoreConfig |
encode(message, writer)
public static encode(message: google.cloud.gkebackup.v1.IRestoreConfig, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified RestoreConfig message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IRestoreConfig
RestoreConfig 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.cloud.gkebackup.v1.IRestoreConfig, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified RestoreConfig message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IRestoreConfig
RestoreConfig 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.cloud.gkebackup.v1.RestoreConfig;
Creates a RestoreConfig 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 |
RestoreConfig | RestoreConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for RestoreConfig
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 RestoreConfig to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.gkebackup.v1.RestoreConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a RestoreConfig message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
RestoreConfig
RestoreConfig |
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 RestoreConfig message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|