BeyondCorp Client Gateways v1 API - Class ClientGatewayName (1.3.0) 

public sealed class ClientGatewayName : IResourceName, IEquatable<ClientGatewayName>

Reference documentation and code samples for the BeyondCorp Client Gateways v1 API class ClientGatewayName.

Resource name for the ClientGateway resource.

Inheritance

object > ClientGatewayName

Namespace

Google.Cloud.BeyondCorp.ClientGateways.V1

Assembly

Google.Cloud.BeyondCorp.ClientGateways.V1.dll

Constructors

ClientGatewayName(string, string, string)

public ClientGatewayName(string projectId, string locationId, string clientGatewayId)

Constructs a new instance of a ClientGatewayName class from the component parts of pattern projects/{project}/locations/{location}/clientGateways/{client_gateway}

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.
clientGatewayId string

The ClientGateway ID. Must not be null or empty.

Properties

ClientGatewayId

public string ClientGatewayId { get; }

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

Property Value
Type Description
string

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

Type

public ClientGatewayName.ResourceNameType Type { get; }

The ClientGatewayName.ResourceNameType of the contained resource name.

Property Value
Type Description
ClientGatewayNameResourceNameType

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

Formats the IDs into the string representation of this ClientGatewayName with pattern projects/{project}/locations/{location}/clientGateways/{client_gateway}.

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.
clientGatewayId string

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

The string representation of this ClientGatewayName with pattern projects/{project}/locations/{location}/clientGateways/{client_gateway}.

FormatProjectLocationClientGateway(string, string, string)

public static string FormatProjectLocationClientGateway(string projectId, string locationId, string clientGatewayId)

Formats the IDs into the string representation of this ClientGatewayName with pattern projects/{project}/locations/{location}/clientGateways/{client_gateway}.

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.
clientGatewayId string

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

The string representation of this ClientGatewayName with pattern projects/{project}/locations/{location}/clientGateways/{client_gateway}.

FromProjectLocationClientGateway(string, string, string)

public static ClientGatewayName FromProjectLocationClientGateway(string projectId, string locationId, string clientGatewayId)

Creates a ClientGatewayName with the pattern projects/{project}/locations/{location}/clientGateways/{client_gateway}.

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.
clientGatewayId string

The ClientGateway ID. Must not be null or empty.
Returns
Type Description
ClientGatewayName

A new instance of ClientGatewayName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ClientGatewayName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ClientGatewayName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ClientGatewayName 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 ClientGatewayName Parse(string clientGatewayName)

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

Parameter
Name Description
clientGatewayName string

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

The parsed ClientGatewayName if successful.
Remarks

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

  • projects/{project}/locations/{location}/clientGateways/{client_gateway}

Parse(string, bool)

public static ClientGatewayName Parse(string clientGatewayName, bool allowUnparsed)

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

Parameters
Name Description
clientGatewayName 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
ClientGatewayName

The parsed ClientGatewayName if successful.
Remarks

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

  • projects/{project}/locations/{location}/clientGateways/{client_gateway}
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 ClientGatewayName)

public static bool TryParse(string clientGatewayName, out ClientGatewayName result)

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

Parameters
Name Description
clientGatewayName string

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

When this method returns, the parsed ClientGatewayName, 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}/clientGateways/{client_gateway}

TryParse(string, bool, out ClientGatewayName)

public static bool TryParse(string clientGatewayName, bool allowUnparsed, out ClientGatewayName result)

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

Parameters
Name Description
clientGatewayName 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 ClientGatewayName

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

Operators

operator ==(ClientGatewayName, ClientGatewayName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ClientGatewayName

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

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 !=(ClientGatewayName, ClientGatewayName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ClientGatewayName

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

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.