Class SubscriptionName

Resource name for the Subscription resource.

Inheritance

System.Object

SubscriptionName

Implements

IResourceName

System.IEquatable<SubscriptionName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.PubSub.V1

Assembly: Google.Cloud.PubSub.V1.dll

Syntax

public sealed class SubscriptionName : IResourceName, IEquatable<SubscriptionName>

Constructors

SubscriptionName(String, String)

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

Declaration

public SubscriptionName(string projectId, string subscriptionId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	subscriptionId	The Subscription ID. Must not be null or empty.

Properties

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

SubscriptionId

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

Declaration

public string SubscriptionId { get; }

Property Value

Type	Description
System.String

Type

The SubscriptionName.ResourceNameType of the contained resource name.

Declaration

public SubscriptionName.ResourceNameType Type { get; }

Property Value

Type	Description
SubscriptionName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(String, String)

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

Declaration

public static string Format(string projectId, string subscriptionId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	subscriptionId	The Subscription ID. Must not be null or empty.

Returns

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

FormatProjectSubscription(String, String)

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

Declaration

public static string FormatProjectSubscription(string projectId, string subscriptionId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	subscriptionId	The Subscription ID. Must not be null or empty.

Returns

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

FromProjectSubscription(String, String)

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

Declaration

public static SubscriptionName FromProjectSubscription(string projectId, string subscriptionId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	subscriptionId	The Subscription ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a SubscriptionName containing an unparsed resource name.

Declaration

public static SubscriptionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
SubscriptionName	A new instance of SubscriptionName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static SubscriptionName Parse(string subscriptionName)

Parameters

Type	Name	Description
System.String	subscriptionName	The resource name in string form. Must not be null.

Returns

Type	Description
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)

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

Declaration

public static SubscriptionName Parse(string subscriptionName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	subscriptionName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
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()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out SubscriptionName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	subscriptionName	The resource name in string form. Must not be null.
SubscriptionName	result	When this method returns, the parsed SubscriptionName, or null if parsing failed.

Returns

Type	Description
System.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)

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

Declaration

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

Parameters

Type	Name	Description
System.String	subscriptionName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
SubscriptionName	result	When this method returns, the parsed SubscriptionName, or null if parsing failed.

Returns

Type	Description
System.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)

Declaration

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

Parameters

Type	Name	Description
SubscriptionName	a
SubscriptionName	b

Returns

Type	Description
System.Boolean

Inequality(SubscriptionName, SubscriptionName)

Declaration

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

Parameters

Type	Name	Description
SubscriptionName	a
SubscriptionName	b

Returns

Type	Description
System.Boolean