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

public sealed class ParameterName : IResourceName, IEquatable<ParameterName>

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

Resource name for the Parameter resource.

Inheritance

object > ParameterName

Namespace

Google.Cloud.ParameterManager.V1

Assembly

Google.Cloud.ParameterManager.V1.dll

Constructors

ParameterName(string, string, string)

public ParameterName(string projectId, string locationId, string parameterId)

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

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.

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

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

The ParameterName.ResourceNameType of the contained resource name.

Property Value
Type Description
ParameterNameResourceNameType

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

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

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.
Returns
Type Description
string

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

FormatProjectLocationParameter(string, string, string)

public static string FormatProjectLocationParameter(string projectId, string locationId, string parameterId)

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

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.
Returns
Type Description
string

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

FromProjectLocationParameter(string, string, string)

public static ParameterName FromProjectLocationParameter(string projectId, string locationId, string parameterId)

Creates a ParameterName with the pattern projects/{project}/locations/{location}/parameters/{parameter}.

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.
Returns
Type Description
ParameterName

A new instance of ParameterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ParameterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ParameterName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
parameterName string

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

The parsed ParameterName if successful.
Remarks

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

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

Parse(string, bool)

public static ParameterName Parse(string parameterName, bool allowUnparsed)

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

Parameters
Name Description
parameterName 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
ParameterName

The parsed ParameterName if successful.
Remarks

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

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

public static bool TryParse(string parameterName, out ParameterName result)

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

Parameters
Name Description
parameterName string

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

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

TryParse(string, bool, out ParameterName)

public static bool TryParse(string parameterName, bool allowUnparsed, out ParameterName result)

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

Parameters
Name Description
parameterName 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 ParameterName

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

Operators

operator ==(ParameterName, ParameterName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ParameterName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ParameterName

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

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.