public sealed class SnapshotName : IResourceName, IEquatable<SnapshotName>
Reference documentation and code samples for the Cloud Pub/Sub v1 API class SnapshotName.
Resource name for the Snapshot
resource.
Namespace
Google.Cloud.PubSub.V1Assembly
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 |
string The |
snapshotId |
string The |
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 |
SnapshotId
public string SnapshotId { get; }
The Snapshot
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public SnapshotName.ResourceNameType Type { get; }
The SnapshotName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
SnapshotNameResourceNameType |
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 snapshotId)
Formats the IDs into the string representation of this SnapshotName with pattern
projects/{project}/snapshots/{snapshot}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
snapshotId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this SnapshotName with pattern
|
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 |
string The |
snapshotId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this SnapshotName with pattern
|
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 |
string The |
snapshotId |
string The |
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 |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
SnapshotName |
A new instance of SnapshotName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static SnapshotName Parse(string snapshotName)
Parses the given resource name string into a new SnapshotName instance.
Parameter | |
---|---|
Name | Description |
snapshotName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
SnapshotName |
The parsed SnapshotName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/snapshots/{snapshot}
Parse(string, bool)
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 |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
SnapshotName |
The parsed SnapshotName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/snapshots/{snapshot}
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. |
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 |
string The resource name in string form. Must not be |
result |
SnapshotName When this method returns, the parsed SnapshotName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/snapshots/{snapshot}
TryParse(string, bool, 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 |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
SnapshotName When this method returns, the parsed SnapshotName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/snapshots/{snapshot}
allowUnparsed
is true
.
Operators
operator ==(SnapshotName, SnapshotName)
public static bool operator ==(SnapshotName a, SnapshotName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
SnapshotName The first resource name to compare, or null. |
b |
SnapshotName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(SnapshotName, SnapshotName)
public static bool operator !=(SnapshotName a, SnapshotName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
SnapshotName The first resource name to compare, or null. |
b |
SnapshotName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |