Backup and DR Service v1beta API - Class AutoProtectionPolicyName (1.0.0-beta01) 

public sealed class AutoProtectionPolicyName : IResourceName, IEquatable<AutoProtectionPolicyName>

Reference documentation and code samples for the Backup and DR Service v1beta API class AutoProtectionPolicyName.

Resource name for the AutoProtectionPolicy resource.

Inheritance

object > AutoProtectionPolicyName

Namespace

Google.Cloud.BackupDR.V1Beta

Assembly

Google.Cloud.BackupDR.V1Beta.dll

Constructors

AutoProtectionPolicyName(string, string, string)

public AutoProtectionPolicyName(string projectId, string locationId, string autoProtectionPolicyId)

Constructs a new instance of a AutoProtectionPolicyName class from the component parts of pattern projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}

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.
autoProtectionPolicyId string

The AutoProtectionPolicy ID. Must not be null or empty.

Properties

AutoProtectionPolicyId

public string AutoProtectionPolicyId { get; }

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

Property Value
Type Description
string

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

Type

public AutoProtectionPolicyName.ResourceNameType Type { get; }

The AutoProtectionPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
AutoProtectionPolicyNameResourceNameType

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 autoProtectionPolicyId)

Formats the IDs into the string representation of this AutoProtectionPolicyName with pattern projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}.

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.
autoProtectionPolicyId string

The AutoProtectionPolicy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AutoProtectionPolicyName with pattern projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}.

FormatProjectLocationAutoProtectionPolicy(string, string, string)

public static string FormatProjectLocationAutoProtectionPolicy(string projectId, string locationId, string autoProtectionPolicyId)

Formats the IDs into the string representation of this AutoProtectionPolicyName with pattern projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}.

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.
autoProtectionPolicyId string

The AutoProtectionPolicy ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AutoProtectionPolicyName with pattern projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}.

FromProjectLocationAutoProtectionPolicy(string, string, string)

public static AutoProtectionPolicyName FromProjectLocationAutoProtectionPolicy(string projectId, string locationId, string autoProtectionPolicyId)

Creates a AutoProtectionPolicyName with the pattern projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}.

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.
autoProtectionPolicyId string

The AutoProtectionPolicy ID. Must not be null or empty.
Returns
Type Description
AutoProtectionPolicyName

A new instance of AutoProtectionPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AutoProtectionPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AutoProtectionPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
AutoProtectionPolicyName

A new instance of AutoProtectionPolicyName 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 AutoProtectionPolicyName Parse(string autoProtectionPolicyName)

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

Parameter
Name Description
autoProtectionPolicyName string

The resource name in string form. Must not be null.
Returns
Type Description
AutoProtectionPolicyName

The parsed AutoProtectionPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}

Parse(string, bool)

public static AutoProtectionPolicyName Parse(string autoProtectionPolicyName, bool allowUnparsed)

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

Parameters
Name Description
autoProtectionPolicyName 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
AutoProtectionPolicyName

The parsed AutoProtectionPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}

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 AutoProtectionPolicyName)

public static bool TryParse(string autoProtectionPolicyName, out AutoProtectionPolicyName result)

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

Parameters
Name Description
autoProtectionPolicyName string

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

When this method returns, the parsed AutoProtectionPolicyName, 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}/autoProtectionPolicies/{auto_protection_policy}

TryParse(string, bool, out AutoProtectionPolicyName)

public static bool TryParse(string autoProtectionPolicyName, bool allowUnparsed, out AutoProtectionPolicyName result)

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

Parameters
Name Description
autoProtectionPolicyName 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 AutoProtectionPolicyName

When this method returns, the parsed AutoProtectionPolicyName, 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}/autoProtectionPolicies/{auto_protection_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AutoProtectionPolicyName, AutoProtectionPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AutoProtectionPolicyName

The first resource name to compare, or null.
b AutoProtectionPolicyName

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 !=(AutoProtectionPolicyName, AutoProtectionPolicyName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AutoProtectionPolicyName

The first resource name to compare, or null.
b AutoProtectionPolicyName

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.