Cloud IDS v1 API - Class EndpointName (2.1.0)

public sealed class EndpointName : IResourceName, IEquatable<EndpointName>

Reference documentation and code samples for the Cloud IDS v1 API class EndpointName.

Resource name for the Endpoint resource.

Inheritance

Object > EndpointName

Namespace

Google.Cloud.Ids.V1

Assembly

Google.Cloud.Ids.V1.dll

Constructors

EndpointName(String, String, String)

public EndpointName(string projectId, string locationId, string endpointId)

Constructs a new instance of a EndpointName class from the component parts of pattern projects/{project}/locations/{location}/endpoints/{endpoint}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

endpointIdString

The Endpoint ID. Must not be null or empty.

Properties

EndpointId

public string EndpointId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public EndpointName.ResourceNameType Type { get; }

The EndpointName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
EndpointName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

public static string Format(string projectId, string locationId, string endpointId)

Formats the IDs into the string representation of this EndpointName with pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

endpointIdString

The Endpoint ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this EndpointName with pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

FormatProjectLocationEndpoint(String, String, String)

public static string FormatProjectLocationEndpoint(string projectId, string locationId, string endpointId)

Formats the IDs into the string representation of this EndpointName with pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

endpointIdString

The Endpoint ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this EndpointName with pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

FromProjectLocationEndpoint(String, String, String)

public static EndpointName FromProjectLocationEndpoint(string projectId, string locationId, string endpointId)

Creates a EndpointName with the pattern projects/{project}/locations/{location}/endpoints/{endpoint}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

endpointIdString

The Endpoint ID. Must not be null or empty.

Returns
TypeDescription
EndpointName

A new instance of EndpointName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EndpointName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EndpointName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
EndpointName

A new instance of EndpointName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static EndpointName Parse(string endpointName)

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

Parameter
NameDescription
endpointNameString

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

Returns
TypeDescription
EndpointName

The parsed EndpointName if successful.

Remarks

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

  • projects/{project}/locations/{location}/endpoints/{endpoint}

Parse(String, Boolean)

public static EndpointName Parse(string endpointName, bool allowUnparsed)

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

Parameters
NameDescription
endpointNameString

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

allowUnparsedBoolean

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
TypeDescription
EndpointName

The parsed EndpointName if successful.

Remarks

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

  • projects/{project}/locations/{location}/endpoints/{endpoint}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out EndpointName)

public static bool TryParse(string endpointName, out EndpointName result)

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

Parameters
NameDescription
endpointNameString

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

resultEndpointName

When this method returns, the parsed EndpointName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/endpoints/{endpoint}

TryParse(String, Boolean, out EndpointName)

public static bool TryParse(string endpointName, bool allowUnparsed, out EndpointName result)

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

Parameters
NameDescription
endpointNameString

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

allowUnparsedBoolean

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.

resultEndpointName

When this method returns, the parsed EndpointName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/endpoints/{endpoint}
Or may be in any format if allowUnparsed is true.

Operators

Equality(EndpointName, EndpointName)

public static bool operator ==(EndpointName a, EndpointName b)
Parameters
NameDescription
aEndpointName
bEndpointName
Returns
TypeDescription
Boolean

Inequality(EndpointName, EndpointName)

public static bool operator !=(EndpointName a, EndpointName b)
Parameters
NameDescription
aEndpointName
bEndpointName
Returns
TypeDescription
Boolean