Backup and DR Service v1 API - Class ResourceBackupConfigName (2.7.0) 

public sealed class ResourceBackupConfigName : IResourceName, IEquatable<ResourceBackupConfigName>

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

Resource name for the ResourceBackupConfig resource.

Inheritance

object > ResourceBackupConfigName

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

ResourceBackupConfigName(string, string, string)

public ResourceBackupConfigName(string projectId, string locationId, string resourceBackupConfigId)

Constructs a new instance of a ResourceBackupConfigName class from the component parts of pattern projects/{project}/locations/{location}/resourceBackupConfigs/{resource_backup_config}

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

The ResourceBackupConfig 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

ResourceBackupConfigId

public string ResourceBackupConfigId { get; }

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

Property Value
Type Description
string

Type

public ResourceBackupConfigName.ResourceNameType Type { get; }

The ResourceBackupConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
ResourceBackupConfigNameResourceNameType

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

Formats the IDs into the string representation of this ResourceBackupConfigName with pattern projects/{project}/locations/{location}/resourceBackupConfigs/{resource_backup_config}.

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

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

The string representation of this ResourceBackupConfigName with pattern projects/{project}/locations/{location}/resourceBackupConfigs/{resource_backup_config}.

FormatProjectLocationResourceBackupConfig(string, string, string)

public static string FormatProjectLocationResourceBackupConfig(string projectId, string locationId, string resourceBackupConfigId)

Formats the IDs into the string representation of this ResourceBackupConfigName with pattern projects/{project}/locations/{location}/resourceBackupConfigs/{resource_backup_config}.

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

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

The string representation of this ResourceBackupConfigName with pattern projects/{project}/locations/{location}/resourceBackupConfigs/{resource_backup_config}.

FromProjectLocationResourceBackupConfig(string, string, string)

public static ResourceBackupConfigName FromProjectLocationResourceBackupConfig(string projectId, string locationId, string resourceBackupConfigId)

Creates a ResourceBackupConfigName with the pattern projects/{project}/locations/{location}/resourceBackupConfigs/{resource_backup_config}.

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

The ResourceBackupConfig ID. Must not be null or empty.
Returns
Type Description
ResourceBackupConfigName

A new instance of ResourceBackupConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ResourceBackupConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourceBackupConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
resourceBackupConfigName string

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

The parsed ResourceBackupConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/resourceBackupConfigs/{resource_backup_config}

Parse(string, bool)

public static ResourceBackupConfigName Parse(string resourceBackupConfigName, bool allowUnparsed)

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

Parameters
Name Description
resourceBackupConfigName 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
ResourceBackupConfigName

The parsed ResourceBackupConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/resourceBackupConfigs/{resource_backup_config}
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 ResourceBackupConfigName)

public static bool TryParse(string resourceBackupConfigName, out ResourceBackupConfigName result)

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

Parameters
Name Description
resourceBackupConfigName string

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

When this method returns, the parsed ResourceBackupConfigName, 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}/resourceBackupConfigs/{resource_backup_config}

TryParse(string, bool, out ResourceBackupConfigName)

public static bool TryParse(string resourceBackupConfigName, bool allowUnparsed, out ResourceBackupConfigName result)

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

Parameters
Name Description
resourceBackupConfigName 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 ResourceBackupConfigName

When this method returns, the parsed ResourceBackupConfigName, 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}/resourceBackupConfigs/{resource_backup_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ResourceBackupConfigName, ResourceBackupConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ResourceBackupConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ResourceBackupConfigName

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

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.