Cloud Build v1 API - Class SubscriptionName (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class SubscriptionName : IResourceName, IEquatable<SubscriptionName>

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

Resource name for the Subscription resource.

Inheritance

Object > SubscriptionName

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

SubscriptionName(String, String)

public SubscriptionName(string projectId, string subscriptionId)

Constructs a new instance of a SubscriptionName class from the component parts of pattern projects/{project}/subscriptions/{subscription}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

subscriptionIdString

The Subscription 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
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

SubscriptionId

public string SubscriptionId { get; }

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

Property Value
TypeDescription
String

Type

public SubscriptionName.ResourceNameType Type { get; }

The SubscriptionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SubscriptionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String)

public static string Format(string projectId, string subscriptionId)

Formats the IDs into the string representation of this SubscriptionName with pattern projects/{project}/subscriptions/{subscription}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

subscriptionIdString

The Subscription ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this SubscriptionName with pattern projects/{project}/subscriptions/{subscription}.

FormatProjectSubscription(String, String)

public static string FormatProjectSubscription(string projectId, string subscriptionId)

Formats the IDs into the string representation of this SubscriptionName with pattern projects/{project}/subscriptions/{subscription}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

subscriptionIdString

The Subscription ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this SubscriptionName with pattern projects/{project}/subscriptions/{subscription}.

FromProjectSubscription(String, String)

public static SubscriptionName FromProjectSubscription(string projectId, string subscriptionId)

Creates a SubscriptionName with the pattern projects/{project}/subscriptions/{subscription} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

subscriptionIdString

The Subscription ID. Must not be null or empty.

Returns
TypeDescription
SubscriptionName

A new instance of SubscriptionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SubscriptionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SubscriptionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SubscriptionName

A new instance of SubscriptionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static SubscriptionName Parse(string subscriptionName)

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

Parameter
NameDescription
subscriptionNameString

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

Returns
TypeDescription
SubscriptionName

The parsed SubscriptionName if successful.

Remarks

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

  • projects/{project}/subscriptions/{subscription}

Parse(String, Boolean)

public static SubscriptionName Parse(string subscriptionName, bool allowUnparsed)

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

Parameters
NameDescription
subscriptionNameString

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

allowUnparsedBoolean

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
TypeDescription
SubscriptionName

The parsed SubscriptionName if successful.

Remarks

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

  • projects/{project}/subscriptions/{subscription}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out SubscriptionName)

public static bool TryParse(string subscriptionName, out SubscriptionName result)

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

Parameters
NameDescription
subscriptionNameString

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

resultSubscriptionName

When this method returns, the parsed SubscriptionName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/subscriptions/{subscription}

TryParse(String, Boolean, out SubscriptionName)

public static bool TryParse(string subscriptionName, bool allowUnparsed, out SubscriptionName result)

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

Parameters
NameDescription
subscriptionNameString

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

allowUnparsedBoolean

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.

resultSubscriptionName

When this method returns, the parsed SubscriptionName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/subscriptions/{subscription}
Or may be in any format if allowUnparsed is true.

Operators

Equality(SubscriptionName, SubscriptionName)

public static bool operator ==(SubscriptionName a, SubscriptionName b)
Parameters
NameDescription
aSubscriptionName
bSubscriptionName
Returns
TypeDescription
Boolean

Inequality(SubscriptionName, SubscriptionName)

public static bool operator !=(SubscriptionName a, SubscriptionName b)
Parameters
NameDescription
aSubscriptionName
bSubscriptionName
Returns
TypeDescription
Boolean