Network Services v1 API - Class GatewaySecurityPolicyName (1.5.0) 

public sealed class GatewaySecurityPolicyName : IResourceName, IEquatable<GatewaySecurityPolicyName>

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

Resource name for the GatewaySecurityPolicy resource.

Inheritance

object > GatewaySecurityPolicyName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

GatewaySecurityPolicyName(string, string, string)

public GatewaySecurityPolicyName(string projectId, string locationId, string gatewaySecurityPolicyId)

Constructs a new instance of a GatewaySecurityPolicyName class from the component parts of pattern projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}

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

The GatewaySecurityPolicy ID. Must not be null or empty.

Properties

GatewaySecurityPolicyId

public string GatewaySecurityPolicyId { get; }

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

The GatewaySecurityPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
GatewaySecurityPolicyNameResourceNameType

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

Formats the IDs into the string representation of this GatewaySecurityPolicyName with pattern projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}.

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

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

The string representation of this GatewaySecurityPolicyName with pattern projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}.

FormatProjectLocationGatewaySecurityPolicy(string, string, string)

public static string FormatProjectLocationGatewaySecurityPolicy(string projectId, string locationId, string gatewaySecurityPolicyId)

Formats the IDs into the string representation of this GatewaySecurityPolicyName with pattern projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}.

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

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

The string representation of this GatewaySecurityPolicyName with pattern projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}.

FromProjectLocationGatewaySecurityPolicy(string, string, string)

public static GatewaySecurityPolicyName FromProjectLocationGatewaySecurityPolicy(string projectId, string locationId, string gatewaySecurityPolicyId)

Creates a GatewaySecurityPolicyName with the pattern projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}.

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

The GatewaySecurityPolicy ID. Must not be null or empty.
Returns
Type Description
GatewaySecurityPolicyName

A new instance of GatewaySecurityPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GatewaySecurityPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GatewaySecurityPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
gatewaySecurityPolicyName string

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

The parsed GatewaySecurityPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}

Parse(string, bool)

public static GatewaySecurityPolicyName Parse(string gatewaySecurityPolicyName, bool allowUnparsed)

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

Parameters
Name Description
gatewaySecurityPolicyName 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
GatewaySecurityPolicyName

The parsed GatewaySecurityPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}
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 GatewaySecurityPolicyName)

public static bool TryParse(string gatewaySecurityPolicyName, out GatewaySecurityPolicyName result)

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

Parameters
Name Description
gatewaySecurityPolicyName string

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

When this method returns, the parsed GatewaySecurityPolicyName, 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}/gatewaySecurityPolicies/{gateway_security_policy}

TryParse(string, bool, out GatewaySecurityPolicyName)

public static bool TryParse(string gatewaySecurityPolicyName, bool allowUnparsed, out GatewaySecurityPolicyName result)

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

Parameters
Name Description
gatewaySecurityPolicyName 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 GatewaySecurityPolicyName

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

Operators

operator ==(GatewaySecurityPolicyName, GatewaySecurityPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GatewaySecurityPolicyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GatewaySecurityPolicyName

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

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.