Network Services v1 API - Class AgentGatewayName (1.6.0) 

public sealed class AgentGatewayName : IResourceName, IEquatable<AgentGatewayName>

Reference documentation and code samples for the Network Services v1 API class AgentGatewayName.

Resource name for the AgentGateway resource.

Inheritance

object > AgentGatewayName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

AgentGatewayName(string, string, string)

public AgentGatewayName(string projectId, string locationId, string agentGatewayId)

Constructs a new instance of a AgentGatewayName class from the component parts of pattern projects/{project}/locations/{location}/agentGateways/{agent_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.
agentGatewayId string

The AgentGateway ID. Must not be null or empty.

Properties

AgentGatewayId

public string AgentGatewayId { get; }

The AgentGateway 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 AgentGatewayName.ResourceNameType Type { get; }

The AgentGatewayName.ResourceNameType of the contained resource name.

Property Value
Type Description
AgentGatewayNameResourceNameType

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

Formats the IDs into the string representation of this AgentGatewayName with pattern projects/{project}/locations/{location}/agentGateways/{agent_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.
agentGatewayId string

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

The string representation of this AgentGatewayName with pattern projects/{project}/locations/{location}/agentGateways/{agent_gateway}.

FormatProjectLocationAgentGateway(string, string, string)

public static string FormatProjectLocationAgentGateway(string projectId, string locationId, string agentGatewayId)

Formats the IDs into the string representation of this AgentGatewayName with pattern projects/{project}/locations/{location}/agentGateways/{agent_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.
agentGatewayId string

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

The string representation of this AgentGatewayName with pattern projects/{project}/locations/{location}/agentGateways/{agent_gateway}.

FromProjectLocationAgentGateway(string, string, string)

public static AgentGatewayName FromProjectLocationAgentGateway(string projectId, string locationId, string agentGatewayId)

Creates a AgentGatewayName with the pattern projects/{project}/locations/{location}/agentGateways/{agent_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.
agentGatewayId string

The AgentGateway ID. Must not be null or empty.
Returns
Type Description
AgentGatewayName

A new instance of AgentGatewayName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AgentGatewayName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AgentGatewayName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
agentGatewayName string

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

The parsed AgentGatewayName if successful.
Remarks

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

  • projects/{project}/locations/{location}/agentGateways/{agent_gateway}

Parse(string, bool)

public static AgentGatewayName Parse(string agentGatewayName, bool allowUnparsed)

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

Parameters
Name Description
agentGatewayName 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
AgentGatewayName

The parsed AgentGatewayName if successful.
Remarks

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

  • projects/{project}/locations/{location}/agentGateways/{agent_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 AgentGatewayName)

public static bool TryParse(string agentGatewayName, out AgentGatewayName result)

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

Parameters
Name Description
agentGatewayName string

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

When this method returns, the parsed AgentGatewayName, 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}/agentGateways/{agent_gateway}

TryParse(string, bool, out AgentGatewayName)

public static bool TryParse(string agentGatewayName, bool allowUnparsed, out AgentGatewayName result)

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

Parameters
Name Description
agentGatewayName 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 AgentGatewayName

When this method returns, the parsed AgentGatewayName, 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}/agentGateways/{agent_gateway}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AgentGatewayName, AgentGatewayName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AgentGatewayName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AgentGatewayName

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

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.