Class EndpointName (2.0.0) 

public sealed class EndpointName : IResourceName, IEquatable<EndpointName>

Resource name for the Endpoint resource.

Inheritance

Object > EndpointName

Namespace

Google.Cloud.ApigeeConnect.V1

Assembly

Google.Cloud.ApigeeConnect.V1.dll

Constructors

EndpointName(String, String)

public EndpointName(string projectId, string endpointId)

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

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
endpointId String

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
Type Description
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
Boolean

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 EndpointName.ResourceNameType Type { get; }

The EndpointName.ResourceNameType of the contained resource name.

Property Value
Type Description
EndpointName.ResourceNameType

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)

public static string Format(string projectId, string endpointId)

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

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
endpointId String

The Endpoint ID. Must not be null or empty.
Returns
Type Description
String

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

FormatProjectEndpoint(String, String)

public static string FormatProjectEndpoint(string projectId, string endpointId)

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

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
endpointId String

The Endpoint ID. Must not be null or empty.
Returns
Type Description
String

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

FromProjectEndpoint(String, String)

public static EndpointName FromProjectEndpoint(string projectId, string endpointId)

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

Parameters
Name Description
projectId String

The Project ID. Must not be null or empty.
endpointId String

The Endpoint ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of EndpointName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static EndpointName Parse(string endpointName)

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

Parameter
Name Description
endpointName String

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

The parsed EndpointName if successful.
Remarks

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

  • projects/{project}/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
Name Description
endpointName String

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

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
EndpointName

The parsed EndpointName if successful.
Remarks

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

  • projects/{project}/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
Type Description
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
Name Description
endpointName String

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

When this method returns, the parsed EndpointName, or null if parsing failed.
Returns
Type Description
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}/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
Name Description
endpointName String

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

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 EndpointName

When this method returns, the parsed EndpointName, or null if parsing failed.
Returns
Type Description
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}/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
Name Description
a EndpointName
b EndpointName
Returns
Type Description
Boolean

Inequality(EndpointName, EndpointName)

public static bool operator !=(EndpointName a, EndpointName b)
Parameters
Name Description
a EndpointName
b EndpointName
Returns
Type Description
Boolean