Network Security v1 API - Class SACRealmName (1.0.0-beta01) 

public sealed class SACRealmName : IResourceName, IEquatable<SACRealmName>

Reference documentation and code samples for the Network Security v1 API class SACRealmName.

Resource name for the SACRealm resource.

Inheritance

object > SACRealmName

Namespace

Google.Cloud.NetworkSecurity.V1

Assembly

Google.Cloud.NetworkSecurity.V1.dll

Constructors

SACRealmName(string, string, string)

public SACRealmName(string projectId, string locationId, string sacRealmId)

Constructs a new instance of a SACRealmName class from the component parts of pattern projects/{project}/locations/{location}/sacRealms/{sac_realm}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
sacRealmId string

The SacRealm 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
bool

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

SacRealmId

public string SacRealmId { get; }

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

Property Value
Type Description
string

Type

public SACRealmName.ResourceNameType Type { get; }

The SACRealmName.ResourceNameType of the contained resource name.

Property Value
Type Description
SACRealmNameResourceNameType

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 sacRealmId)

Formats the IDs into the string representation of this SACRealmName with pattern projects/{project}/locations/{location}/sacRealms/{sac_realm}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
sacRealmId string

The SacRealm ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SACRealmName with pattern projects/{project}/locations/{location}/sacRealms/{sac_realm}.

FormatProjectLocationSacRealm(string, string, string)

public static string FormatProjectLocationSacRealm(string projectId, string locationId, string sacRealmId)

Formats the IDs into the string representation of this SACRealmName with pattern projects/{project}/locations/{location}/sacRealms/{sac_realm}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
sacRealmId string

The SacRealm ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SACRealmName with pattern projects/{project}/locations/{location}/sacRealms/{sac_realm}.

FromProjectLocationSacRealm(string, string, string)

public static SACRealmName FromProjectLocationSacRealm(string projectId, string locationId, string sacRealmId)

Creates a SACRealmName with the pattern projects/{project}/locations/{location}/sacRealms/{sac_realm}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
sacRealmId string

The SacRealm ID. Must not be null or empty.
Returns
Type Description
SACRealmName

A new instance of SACRealmName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SACRealmName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SACRealmName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of SACRealmName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static SACRealmName Parse(string sACRealmName)

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

Parameter
Name Description
sACRealmName string

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

The parsed SACRealmName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sacRealms/{sac_realm}

Parse(string, bool)

public static SACRealmName Parse(string sACRealmName, bool allowUnparsed)

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

Parameters
Name Description
sACRealmName string

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

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

The parsed SACRealmName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sacRealms/{sac_realm}

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
string

The string representation of the resource name.
Overrides

TryParse(string, out SACRealmName)

public static bool TryParse(string sACRealmName, out SACRealmName result)

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

Parameters
Name Description
sACRealmName string

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

When this method returns, the parsed SACRealmName, or null if parsing failed.
Returns
Type Description
bool

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}/locations/{location}/sacRealms/{sac_realm}

TryParse(string, bool, out SACRealmName)

public static bool TryParse(string sACRealmName, bool allowUnparsed, out SACRealmName result)

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

Parameters
Name Description
sACRealmName string

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

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

When this method returns, the parsed SACRealmName, or null if parsing failed.
Returns
Type Description
bool

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}/locations/{location}/sacRealms/{sac_realm}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SACRealmName, SACRealmName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SACRealmName

The first resource name to compare, or null.
b SACRealmName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(SACRealmName, SACRealmName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SACRealmName

The first resource name to compare, or null.
b SACRealmName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.