Backup and DR Service v1 API - Class RestoreTemplateName (2.11.0)

public sealed class RestoreTemplateName : IResourceName, IEquatable<RestoreTemplateName>

Reference documentation and code samples for the Backup and DR Service v1 API class RestoreTemplateName.

Resource name for the RestoreTemplate resource.

Inheritance

object > RestoreTemplateName

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

RestoreTemplateName(string, string, string)

public RestoreTemplateName(string projectId, string locationId, string restoreTemplateId)

Constructs a new instance of a RestoreTemplateName class from the component parts of pattern projects/{project}/locations/{location}/restoreTemplates/{restore_template}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

restoreTemplateId string

The RestoreTemplate ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

RestoreTemplateId

public string RestoreTemplateId { get; }

The RestoreTemplate ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public RestoreTemplateName.ResourceNameType Type { get; }

The RestoreTemplateName.ResourceNameType of the contained resource name.

Property Value
Type Description
RestoreTemplateNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string restoreTemplateId)

Formats the IDs into the string representation of this RestoreTemplateName with pattern projects/{project}/locations/{location}/restoreTemplates/{restore_template}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

restoreTemplateId string

The RestoreTemplate ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this RestoreTemplateName with pattern projects/{project}/locations/{location}/restoreTemplates/{restore_template}.

FormatProjectLocationRestoreTemplate(string, string, string)

public static string FormatProjectLocationRestoreTemplate(string projectId, string locationId, string restoreTemplateId)

Formats the IDs into the string representation of this RestoreTemplateName with pattern projects/{project}/locations/{location}/restoreTemplates/{restore_template}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

restoreTemplateId string

The RestoreTemplate ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this RestoreTemplateName with pattern projects/{project}/locations/{location}/restoreTemplates/{restore_template}.

FromProjectLocationRestoreTemplate(string, string, string)

public static RestoreTemplateName FromProjectLocationRestoreTemplate(string projectId, string locationId, string restoreTemplateId)

Creates a RestoreTemplateName with the pattern projects/{project}/locations/{location}/restoreTemplates/{restore_template}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

restoreTemplateId string

The RestoreTemplate ID. Must not be null or empty.

Returns
Type Description
RestoreTemplateName

A new instance of RestoreTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RestoreTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RestoreTemplateName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
RestoreTemplateName

A new instance of RestoreTemplateName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static RestoreTemplateName Parse(string restoreTemplateName)

Parses the given resource name string into a new RestoreTemplateName instance.

Parameter
Name Description
restoreTemplateName string

The resource name in string form. Must not be null.

Returns
Type Description
RestoreTemplateName

The parsed RestoreTemplateName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/restoreTemplates/{restore_template}

Parse(string, bool)

public static RestoreTemplateName Parse(string restoreTemplateName, bool allowUnparsed)

Parses the given resource name string into a new RestoreTemplateName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
restoreTemplateName string

The resource name in string form. Must not be null.

allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type Description
RestoreTemplateName

The parsed RestoreTemplateName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/restoreTemplates/{restore_template}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.

Overrides

TryParse(string, out RestoreTemplateName)

public static bool TryParse(string restoreTemplateName, out RestoreTemplateName result)

Tries to parse the given resource name string into a new RestoreTemplateName instance.

Parameters
Name Description
restoreTemplateName string

The resource name in string form. Must not be null.

result RestoreTemplateName

When this method returns, the parsed RestoreTemplateName, or null if parsing failed.

Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/restoreTemplates/{restore_template}

TryParse(string, bool, out RestoreTemplateName)

public static bool TryParse(string restoreTemplateName, bool allowUnparsed, out RestoreTemplateName result)

Tries to parse the given resource name string into a new RestoreTemplateName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
restoreTemplateName string

The resource name in string form. Must not be null.

allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

result RestoreTemplateName

When this method returns, the parsed RestoreTemplateName, or null if parsing failed.

Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/restoreTemplates/{restore_template}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RestoreTemplateName, RestoreTemplateName)

public static bool operator ==(RestoreTemplateName a, RestoreTemplateName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RestoreTemplateName

The first resource name to compare, or null.

b RestoreTemplateName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(RestoreTemplateName, RestoreTemplateName)

public static bool operator !=(RestoreTemplateName a, RestoreTemplateName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a RestoreTemplateName

The first resource name to compare, or null.

b RestoreTemplateName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.