Parameter Manager v1 API - Class ParameterVersionName (1.0.0-beta01) 

public sealed class ParameterVersionName : IResourceName, IEquatable<ParameterVersionName>

Reference documentation and code samples for the Parameter Manager v1 API class ParameterVersionName.

Resource name for the ParameterVersion resource.

Inheritance

object > ParameterVersionName

Namespace

Google.Cloud.ParameterManager.V1

Assembly

Google.Cloud.ParameterManager.V1.dll

Constructors

ParameterVersionName(string, string, string, string)

public ParameterVersionName(string projectId, string locationId, string parameterId, string parameterVersionId)

Constructs a new instance of a ParameterVersionName class from the component parts of pattern projects/{project}/locations/{location}/parameters/{parameter}/versions/{parameter_version}

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

The Parameter ID. Must not be null or empty.
parameterVersionId string

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

ParameterId

public string ParameterId { get; }

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

Property Value
Type Description
string

ParameterVersionId

public string ParameterVersionId { get; }

The ParameterVersion 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 ParameterVersionName.ResourceNameType Type { get; }

The ParameterVersionName.ResourceNameType of the contained resource name.

Property Value
Type Description
ParameterVersionNameResourceNameType

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

Formats the IDs into the string representation of this ParameterVersionName with pattern projects/{project}/locations/{location}/parameters/{parameter}/versions/{parameter_version}.

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

The Parameter ID. Must not be null or empty.
parameterVersionId string

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

The string representation of this ParameterVersionName with pattern projects/{project}/locations/{location}/parameters/{parameter}/versions/{parameter_version}.

FormatProjectLocationParameterParameterVersion(string, string, string, string)

public static string FormatProjectLocationParameterParameterVersion(string projectId, string locationId, string parameterId, string parameterVersionId)

Formats the IDs into the string representation of this ParameterVersionName with pattern projects/{project}/locations/{location}/parameters/{parameter}/versions/{parameter_version}.

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

The Parameter ID. Must not be null or empty.
parameterVersionId string

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

The string representation of this ParameterVersionName with pattern projects/{project}/locations/{location}/parameters/{parameter}/versions/{parameter_version}.

FromProjectLocationParameterParameterVersion(string, string, string, string)

public static ParameterVersionName FromProjectLocationParameterParameterVersion(string projectId, string locationId, string parameterId, string parameterVersionId)

Creates a ParameterVersionName with the pattern projects/{project}/locations/{location}/parameters/{parameter}/versions/{parameter_version}.

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

The Parameter ID. Must not be null or empty.
parameterVersionId string

The ParameterVersion ID. Must not be null or empty.
Returns
Type Description
ParameterVersionName

A new instance of ParameterVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ParameterVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ParameterVersionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
parameterVersionName string

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

The parsed ParameterVersionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/parameters/{parameter}/versions/{parameter_version}

Parse(string, bool)

public static ParameterVersionName Parse(string parameterVersionName, bool allowUnparsed)

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

Parameters
Name Description
parameterVersionName 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
ParameterVersionName

The parsed ParameterVersionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/parameters/{parameter}/versions/{parameter_version}
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 ParameterVersionName)

public static bool TryParse(string parameterVersionName, out ParameterVersionName result)

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

Parameters
Name Description
parameterVersionName string

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

When this method returns, the parsed ParameterVersionName, 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}/parameters/{parameter}/versions/{parameter_version}

TryParse(string, bool, out ParameterVersionName)

public static bool TryParse(string parameterVersionName, bool allowUnparsed, out ParameterVersionName result)

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

Parameters
Name Description
parameterVersionName 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 ParameterVersionName

When this method returns, the parsed ParameterVersionName, 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}/parameters/{parameter}/versions/{parameter_version}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ParameterVersionName, ParameterVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ParameterVersionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ParameterVersionName

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

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.