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

public sealed class FirewallEndpointName : IResourceName, IEquatable<FirewallEndpointName>

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

Resource name for the FirewallEndpoint resource.

Inheritance

object > FirewallEndpointName

Namespace

Google.Cloud.NetworkSecurity.V1

Assembly

Google.Cloud.NetworkSecurity.V1.dll

Constructors

FirewallEndpointName(string, string, string)

public FirewallEndpointName(string organizationId, string locationId, string firewallEndpointId)

Constructs a new instance of a FirewallEndpointName class from the component parts of pattern organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}

Parameters
Name Description
organizationId string

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

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

The FirewallEndpoint ID. Must not be null or empty.

Properties

FirewallEndpointId

public string FirewallEndpointId { get; }

The FirewallEndpoint ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public FirewallEndpointName.ResourceNameType Type { get; }

The FirewallEndpointName.ResourceNameType of the contained resource name.

Property Value
Type Description
FirewallEndpointNameResourceNameType

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 organizationId, string locationId, string firewallEndpointId)

Formats the IDs into the string representation of this FirewallEndpointName with pattern organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}.

Parameters
Name Description
organizationId string

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

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

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

The string representation of this FirewallEndpointName with pattern organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}.

FormatOrganizationLocationFirewallEndpoint(string, string, string)

public static string FormatOrganizationLocationFirewallEndpoint(string organizationId, string locationId, string firewallEndpointId)

Formats the IDs into the string representation of this FirewallEndpointName with pattern organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}.

Parameters
Name Description
organizationId string

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

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

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

The string representation of this FirewallEndpointName with pattern organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}.

FormatProjectLocationFirewallEndpoint(string, string, string)

public static string FormatProjectLocationFirewallEndpoint(string projectId, string locationId, string firewallEndpointId)

Formats the IDs into the string representation of this FirewallEndpointName with pattern projects/{project}/locations/{location}/firewallEndpoints/{firewall_endpoint}.

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

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

The string representation of this FirewallEndpointName with pattern projects/{project}/locations/{location}/firewallEndpoints/{firewall_endpoint}.

FromOrganizationLocationFirewallEndpoint(string, string, string)

public static FirewallEndpointName FromOrganizationLocationFirewallEndpoint(string organizationId, string locationId, string firewallEndpointId)

Creates a FirewallEndpointName with the pattern organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}.

Parameters
Name Description
organizationId string

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

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

The FirewallEndpoint ID. Must not be null or empty.
Returns
Type Description
FirewallEndpointName

A new instance of FirewallEndpointName constructed from the provided ids.

FromProjectLocationFirewallEndpoint(string, string, string)

public static FirewallEndpointName FromProjectLocationFirewallEndpoint(string projectId, string locationId, string firewallEndpointId)

Creates a FirewallEndpointName with the pattern projects/{project}/locations/{location}/firewallEndpoints/{firewall_endpoint}.

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

The FirewallEndpoint ID. Must not be null or empty.
Returns
Type Description
FirewallEndpointName

A new instance of FirewallEndpointName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FirewallEndpointName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FirewallEndpointName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
firewallEndpointName string

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

The parsed FirewallEndpointName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}
  • projects/{project}/locations/{location}/firewallEndpoints/{firewall_endpoint}

Parse(string, bool)

public static FirewallEndpointName Parse(string firewallEndpointName, bool allowUnparsed)

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

Parameters
Name Description
firewallEndpointName 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
FirewallEndpointName

The parsed FirewallEndpointName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}
  • projects/{project}/locations/{location}/firewallEndpoints/{firewall_endpoint}

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

public static bool TryParse(string firewallEndpointName, out FirewallEndpointName result)

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

Parameters
Name Description
firewallEndpointName string

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

When this method returns, the parsed FirewallEndpointName, 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:

  • organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}
  • projects/{project}/locations/{location}/firewallEndpoints/{firewall_endpoint}

TryParse(string, bool, out FirewallEndpointName)

public static bool TryParse(string firewallEndpointName, bool allowUnparsed, out FirewallEndpointName result)

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

Parameters
Name Description
firewallEndpointName 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 FirewallEndpointName

When this method returns, the parsed FirewallEndpointName, 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:

  • organizations/{organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}
  • projects/{project}/locations/{location}/firewallEndpoints/{firewall_endpoint}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FirewallEndpointName, FirewallEndpointName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FirewallEndpointName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FirewallEndpointName

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

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.