Infrastructure Manager v1 API - Class RevisionName (1.6.0)

public sealed class RevisionName : IResourceName, IEquatable<RevisionName>

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

Resource name for the Revision resource.

Inheritance

object > RevisionName

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

RevisionName(string, string, string, string)

public RevisionName(string projectId, string locationId, string deploymentId, string revisionId)

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

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.

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

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 RevisionName.ResourceNameType Type { get; }

The RevisionName.ResourceNameType of the contained resource name.

Property Value
Type Description
RevisionNameResourceNameType

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

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

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.

Returns
Type Description
string

The string representation of this RevisionName with pattern projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}.

FormatProjectLocationDeploymentRevision(string, string, string, string)

public static string FormatProjectLocationDeploymentRevision(string projectId, string locationId, string deploymentId, string revisionId)

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

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.

Returns
Type Description
string

The string representation of this RevisionName with pattern projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}.

FromProjectLocationDeploymentRevision(string, string, string, string)

public static RevisionName FromProjectLocationDeploymentRevision(string projectId, string locationId, string deploymentId, string revisionId)

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

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.

Returns
Type Description
RevisionName

A new instance of RevisionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RevisionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RevisionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
RevisionName

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

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

Parameter
Name Description
revisionName string

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

Returns
Type Description
RevisionName

The parsed RevisionName 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}

Parse(string, bool)

public static RevisionName Parse(string revisionName, bool allowUnparsed)

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

Parameters
Name Description
revisionName 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
RevisionName

The parsed RevisionName 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}
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 RevisionName)

public static bool TryParse(string revisionName, out RevisionName result)

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

Parameters
Name Description
revisionName string

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

result RevisionName

When this method returns, the parsed RevisionName, 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}

TryParse(string, bool, out RevisionName)

public static bool TryParse(string revisionName, bool allowUnparsed, out RevisionName result)

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

Parameters
Name Description
revisionName 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 RevisionName

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

Operators

operator ==(RevisionName, RevisionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RevisionName

The first resource name to compare, or null.

b RevisionName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RevisionName

The first resource name to compare, or null.

b RevisionName

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.