Class SnapshotName (2.3.0) 

public sealed class SnapshotName : IResourceName, IEquatable<SnapshotName>

Resource name for the Snapshot resource.

Inheritance

System.Object > SnapshotName

Implements

Google.Api.Gax.IResourceName, System.IEquatable<SnapshotName>

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

SnapshotName(String, String)

public SnapshotName(string projectId, string snapshotId)

Constructs a new instance of a SnapshotName class from the component parts of pattern projects/{project}/snapshots/{snapshot}

Parameters
Name Description
projectId System.String

The Project ID. Must not be null or empty.
snapshotId System.String

The Snapshot 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
System.Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
System.String

SnapshotId

public string SnapshotId { get; }

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

Property Value
Type Description
System.String

Type

public SnapshotName.ResourceNameType Type { get; }

The SnapshotName.ResourceNameType of the contained resource name.

Property Value
Type Description
SnapshotName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
Google.Api.Gax.UnparsedResourceName

Methods

Format(String, String)

public static string Format(string projectId, string snapshotId)

Formats the IDs into the string representation of this SnapshotName with pattern projects/{project}/snapshots/{snapshot}.

Parameters
Name Description
projectId System.String

The Project ID. Must not be null or empty.
snapshotId System.String

The Snapshot ID. Must not be null or empty.
Returns
Type Description
System.String

The string representation of this SnapshotName with pattern projects/{project}/snapshots/{snapshot}.

FormatProjectSnapshot(String, String)

public static string FormatProjectSnapshot(string projectId, string snapshotId)

Formats the IDs into the string representation of this SnapshotName with pattern projects/{project}/snapshots/{snapshot}.

Parameters
Name Description
projectId System.String

The Project ID. Must not be null or empty.
snapshotId System.String

The Snapshot ID. Must not be null or empty.
Returns
Type Description
System.String

The string representation of this SnapshotName with pattern projects/{project}/snapshots/{snapshot}.

FromProjectSnapshot(String, String)

public static SnapshotName FromProjectSnapshot(string projectId, string snapshotId)

Creates a SnapshotName with the pattern projects/{project}/snapshots/{snapshot}.

Parameters
Name Description
projectId System.String

The Project ID. Must not be null or empty.
snapshotId System.String

The Snapshot ID. Must not be null or empty.
Returns
Type Description
SnapshotName

A new instance of SnapshotName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SnapshotName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SnapshotName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName Google.Api.Gax.UnparsedResourceName

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

A new instance of SnapshotName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

Parse(String)

public static SnapshotName Parse(string snapshotName)

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

Parameter
Name Description
snapshotName System.String

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

The parsed SnapshotName if successful.
Remarks

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

  • projects/{project}/snapshots/{snapshot}

Parse(String, Boolean)

public static SnapshotName Parse(string snapshotName, bool allowUnparsed)

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

Parameters
Name Description
snapshotName System.String

The resource name in string form. Must not be null.
allowUnparsed System.Boolean

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
SnapshotName

The parsed SnapshotName if successful.
Remarks

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

  • projects/{project}/snapshots/{snapshot}
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
System.String

The string representation of the resource name.
Overrides
System.Object.ToString()

TryParse(String, out SnapshotName)

public static bool TryParse(string snapshotName, out SnapshotName result)

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

Parameters
Name Description
snapshotName System.String

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

When this method returns, the parsed SnapshotName, 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}/snapshots/{snapshot}

TryParse(String, Boolean, out SnapshotName)

public static bool TryParse(string snapshotName, bool allowUnparsed, out SnapshotName result)

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

Parameters
Name Description
snapshotName System.String

The resource name in string form. Must not be null.
allowUnparsed System.Boolean

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.
result SnapshotName

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

Operators

Equality(SnapshotName, SnapshotName)

public static bool operator ==(SnapshotName a, SnapshotName b)
Parameters
Name Description
a SnapshotName
b SnapshotName
Returns
Type Description
System.Boolean

Inequality(SnapshotName, SnapshotName)

public static bool operator !=(SnapshotName a, SnapshotName b)
Parameters
Name Description
a SnapshotName
b SnapshotName
Returns
Type Description
System.Boolean