Infrastructure Manager v1 API - Class ResourceDriftName (1.8.0)

public sealed class ResourceDriftName : IResourceName, IEquatable<ResourceDriftName>

Reference documentation and code samples for the Infrastructure Manager v1 API class ResourceDriftName.

Resource name for the ResourceDrift resource.

Inheritance

object > ResourceDriftName

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

ResourceDriftName(string, string, string, string)

public ResourceDriftName(string projectId, string locationId, string previewId, string resourceDriftId)

Constructs a new instance of a ResourceDriftName class from the component parts of pattern projects/{project}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}

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.

previewId string

The Preview ID. Must not be null or empty.

resourceDriftId string

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

PreviewId

public string PreviewId { get; }

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

ResourceDriftId

public string ResourceDriftId { get; }

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

Property Value
Type Description
string

Type

public ResourceDriftName.ResourceNameType Type { get; }

The ResourceDriftName.ResourceNameType of the contained resource name.

Property Value
Type Description
ResourceDriftNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string previewId, string resourceDriftId)

Formats the IDs into the string representation of this ResourceDriftName with pattern projects/{project}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}.

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.

previewId string

The Preview ID. Must not be null or empty.

resourceDriftId string

The ResourceDrift ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ResourceDriftName with pattern projects/{project}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}.

FormatProjectLocationPreviewResourceDrift(string, string, string, string)

public static string FormatProjectLocationPreviewResourceDrift(string projectId, string locationId, string previewId, string resourceDriftId)

Formats the IDs into the string representation of this ResourceDriftName with pattern projects/{project}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}.

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.

previewId string

The Preview ID. Must not be null or empty.

resourceDriftId string

The ResourceDrift ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ResourceDriftName with pattern projects/{project}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}.

FromProjectLocationPreviewResourceDrift(string, string, string, string)

public static ResourceDriftName FromProjectLocationPreviewResourceDrift(string projectId, string locationId, string previewId, string resourceDriftId)

Creates a ResourceDriftName with the pattern projects/{project}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}.

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.

previewId string

The Preview ID. Must not be null or empty.

resourceDriftId string

The ResourceDrift ID. Must not be null or empty.

Returns
Type Description
ResourceDriftName

A new instance of ResourceDriftName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ResourceDriftName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourceDriftName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ResourceDriftName

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

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

Parameter
Name Description
resourceDriftName string

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

Returns
Type Description
ResourceDriftName

The parsed ResourceDriftName if successful.

Remarks

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

  • projects/{project}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}

Parse(string, bool)

public static ResourceDriftName Parse(string resourceDriftName, bool allowUnparsed)

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

Parameters
Name Description
resourceDriftName 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
ResourceDriftName

The parsed ResourceDriftName if successful.

Remarks

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

  • projects/{project}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}
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 ResourceDriftName)

public static bool TryParse(string resourceDriftName, out ResourceDriftName result)

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

Parameters
Name Description
resourceDriftName string

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

result ResourceDriftName

When this method returns, the parsed ResourceDriftName, 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}/previews/{preview}/resourceDrifts/{resource_drift}

TryParse(string, bool, out ResourceDriftName)

public static bool TryParse(string resourceDriftName, bool allowUnparsed, out ResourceDriftName result)

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

Parameters
Name Description
resourceDriftName 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 ResourceDriftName

When this method returns, the parsed ResourceDriftName, 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}/previews/{preview}/resourceDrifts/{resource_drift}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ResourceDriftName, ResourceDriftName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ResourceDriftName

The first resource name to compare, or null.

b ResourceDriftName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ResourceDriftName

The first resource name to compare, or null.

b ResourceDriftName

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.