Infrastructure Manager v1 API - Class ResourceName (1.5.0)

public sealed class ResourceName : IResourceName, IEquatable<ResourceName>

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

Resource name for the Resource resource.

Inheritance

object > ResourceName

Implements

IResourceName, IEquatable ResourceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

ResourceName(string, string, string, string, string)

public ResourceName(string projectId, string locationId, string deploymentId, string revisionId, string resourceId)

Constructs a new instance of a ResourceName class from the component parts of pattern projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource}

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.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.
`revisionId`	`string` The `Revision` ID. Must not be `null` or empty.
`resourceId`	`string` The `Resource` ID. Must not be `null` or empty.

Properties

DeploymentId

public string DeploymentId { get; }

The Deployment 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`

ResourceId

public string ResourceId { get; }

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

Property Value
Type	Description
`string`

RevisionId

public string RevisionId { get; }

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

Property Value
Type	Description
`string`

Type

public ResourceName.ResourceNameType Type { get; }

The ResourceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ResourceNameResourceNameType`

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

public static string Format(string projectId, string locationId, string deploymentId, string revisionId, string resourceId)

Formats the IDs into the string representation of this ResourceName with pattern projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource} .

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.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.
`revisionId`	`string` The `Revision` ID. Must not be `null` or empty.
`resourceId`	`string` The `Resource` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ResourceName with pattern `projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource}` .

FormatProjectLocationDeploymentRevisionResource(string, string, string, string, string)

public static string FormatProjectLocationDeploymentRevisionResource(string projectId, string locationId, string deploymentId, string revisionId, string resourceId)

Formats the IDs into the string representation of this ResourceName with pattern projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource} .

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.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.
`revisionId`	`string` The `Revision` ID. Must not be `null` or empty.
`resourceId`	`string` The `Resource` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ResourceName with pattern `projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource}` .

FromProjectLocationDeploymentRevisionResource(string, string, string, string, string)

public static ResourceName FromProjectLocationDeploymentRevisionResource(string projectId, string locationId, string deploymentId, string revisionId, string resourceId)

Creates a ResourceName with the pattern projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource} .

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.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.
`revisionId`	`string` The `Revision` ID. Must not be `null` or empty.
`resourceId`	`string` The `Resource` ID. Must not be `null` or empty.

Returns
Type	Description
`ResourceName`	A new instance of ResourceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ResourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourceName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ResourceName`	A new instance of ResourceName containing the provided `unparsedResourceName` .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static ResourceName Parse(string resourceName)

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

Parameter
Name	Description
`resourceName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`ResourceName`	The parsed ResourceName if successful.

Remarks

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

projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource}

Parse(string, bool)

public static ResourceName Parse(string resourceName, bool allowUnparsed)

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

Parameters
Name	Description
`resourceName`	`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
`ResourceName`	The parsed ResourceName if successful.

Remarks

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

projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource}

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

object.ToString()

TryParse(string, out ResourceName)

public static bool TryParse(string resourceName, out ResourceName result)

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

Parameters
Name	Description
`resourceName`	`string` The resource name in string form. Must not be `null`.
`result`	`ResourceName` When this method returns, the parsed ResourceName, 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}/deployments/{deployment}/revisions/{revision}/resources/{resource}

TryParse(string, bool, out ResourceName)

public static bool TryParse(string resourceName, bool allowUnparsed, out ResourceName result)

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

Parameters
Name	Description
`resourceName`	`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`	`ResourceName` When this method returns, the parsed ResourceName, 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}/deployments/{deployment}/revisions/{revision}/resources/{resource}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ResourceName, ResourceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ResourceName` The first resource name to compare, or null.
`b`	`ResourceName` 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 !=(ResourceName, ResourceName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ResourceName` The first resource name to compare, or null.
`b`	`ResourceName` 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.