Cloud Build v1 API - Class SecretName (2.3.0)

Version 2.3.0

• 2.13.0 (latest)
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class SecretName : IResourceName, IEquatable<SecretName>

Reference documentation and code samples for the Cloud Build v1 API class SecretName.

Resource name for the Secret resource.

Inheritance

object > SecretName

Implements

IResourceName, IEquatableSecretName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.CloudBuildV1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

SecretName(string, string)

public SecretName(string projectId, string secretId)

Constructs a new instance of a SecretName class from the component parts of pattern projects/{project}/secrets/{secret}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
secretId	string The Secret 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

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

SecretId

public string SecretId { get; }

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

Property Value
Type	Description
string

Type

public SecretName.ResourceNameType Type { get; }

The SecretName.ResourceNameType of the contained resource name.

Property Value
Type	Description
SecretNameResourceNameType

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)

public static string Format(string projectId, string secretId)

Formats the IDs into the string representation of this SecretName with pattern projects/{project}/secrets/{secret}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
secretId	string The Secret ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SecretName with pattern projects/{project}/secrets/{secret}.

FormatProjectSecret(string, string)

public static string FormatProjectSecret(string projectId, string secretId)

Formats the IDs into the string representation of this SecretName with pattern projects/{project}/secrets/{secret}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
secretId	string The Secret ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SecretName with pattern projects/{project}/secrets/{secret}.

FromProjectSecret(string, string)

public static SecretName FromProjectSecret(string projectId, string secretId)

Creates a SecretName with the pattern projects/{project}/secrets/{secret}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
secretId	string The Secret ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static SecretName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecretName containing an unparsed resource name.

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

Returns
Type	Description
SecretName	A new instance of SecretName 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 SecretName Parse(string secretName)

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

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

Returns
Type	Description
SecretName	The parsed SecretName if successful.

Remarks

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

• projects/{project}/secrets/{secret}

Parse(string, bool)

public static SecretName Parse(string secretName, bool allowUnparsed)

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

Parameters
Name	Description
secretName	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
SecretName	The parsed SecretName if successful.

Remarks

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

• projects/{project}/secrets/{secret}

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

public static bool TryParse(string secretName, out SecretName result)

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

Parameters
Name	Description
secretName	string The resource name in string form. Must not be null.
result	SecretName When this method returns, the parsed SecretName, 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}/secrets/{secret}

TryParse(string, bool, out SecretName)

public static bool TryParse(string secretName, bool allowUnparsed, out SecretName result)

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

Parameters
Name	Description
secretName	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	SecretName When this method returns, the parsed SecretName, 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}/secrets/{secret}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SecretName, SecretName)

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

Parameters
Name	Description
a	SecretName
b	SecretName

Returns
Type	Description
bool

operator !=(SecretName, SecretName)

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

Parameters
Name	Description
a	SecretName
b	SecretName

Returns
Type	Description
bool