public sealed class RealmName : IResourceName, IEquatable<RealmName>
Reference documentation and code samples for the Google Cloud for Games v1beta API class RealmName.
Resource name for the Realm
resource.
Namespace
Google.Cloud.Gaming.V1BetaAssembly
Google.Cloud.Gaming.V1Beta.dll
Constructors
RealmName(String, String, String)
public RealmName(string projectId, string locationId, string realmId)
Constructs a new instance of a RealmName class from the component parts of pattern
projects/{project}/locations/{location}/realms/{realm}
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
realmId | String The |
Properties
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
Boolean |
LocationId
public string LocationId { get; }
The Location
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
String |
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 |
RealmId
public string RealmId { get; }
The Realm
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
String |
Type
public RealmName.ResourceNameType Type { get; }
The RealmName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
RealmName.ResourceNameType |
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, String)
public static string Format(string projectId, string locationId, string realmId)
Formats the IDs into the string representation of this RealmName with pattern
projects/{project}/locations/{location}/realms/{realm}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
realmId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this RealmName with pattern
|
FormatProjectLocationRealm(String, String, String)
public static string FormatProjectLocationRealm(string projectId, string locationId, string realmId)
Formats the IDs into the string representation of this RealmName with pattern
projects/{project}/locations/{location}/realms/{realm}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
realmId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this RealmName with pattern
|
FromProjectLocationRealm(String, String, String)
public static RealmName FromProjectLocationRealm(string projectId, string locationId, string realmId)
Creates a RealmName with the pattern projects/{project}/locations/{location}/realms/{realm}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
realmId | String The |
Returns | |
---|---|
Type | Description |
RealmName | A new instance of RealmName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static RealmName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a RealmName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
RealmName | A new instance of RealmName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
Parse(String)
public static RealmName Parse(string realmName)
Parses the given resource name string into a new RealmName instance.
Parameter | |
---|---|
Name | Description |
realmName | String The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
RealmName | The parsed RealmName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/realms/{realm}
Parse(String, Boolean)
public static RealmName Parse(string realmName, bool allowUnparsed)
Parses the given resource name string into a new RealmName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
realmName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
RealmName | The parsed RealmName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/realms/{realm}
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 RealmName)
public static bool TryParse(string realmName, out RealmName result)
Tries to parse the given resource name string into a new RealmName instance.
Parameters | |
---|---|
Name | Description |
realmName | String The resource name in string form. Must not be |
result | RealmName When this method returns, the parsed RealmName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/realms/{realm}
TryParse(String, Boolean, out RealmName)
public static bool TryParse(string realmName, bool allowUnparsed, out RealmName result)
Tries to parse the given resource name string into a new RealmName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
realmName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | RealmName When this method returns, the parsed RealmName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/realms/{realm}
allowUnparsed
is true
.
Operators
Equality(RealmName, RealmName)
public static bool operator ==(RealmName a, RealmName b)
Parameters | |
---|---|
Name | Description |
a | RealmName |
b | RealmName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(RealmName, RealmName)
public static bool operator !=(RealmName a, RealmName b)
Parameters | |
---|---|
Name | Description |
a | RealmName |
b | RealmName |
Returns | |
---|---|
Type | Description |
Boolean |