Network Connectivity v1beta API - Class RemoteTransportProfileName (1.0.0-beta01) 

public sealed class RemoteTransportProfileName : IResourceName, IEquatable<RemoteTransportProfileName>

Reference documentation and code samples for the Network Connectivity v1beta API class RemoteTransportProfileName.

Resource name for the RemoteTransportProfile resource.

Inheritance

object > RemoteTransportProfileName

Namespace

Google.Cloud.NetworkConnectivity.V1Beta

Assembly

Google.Cloud.NetworkConnectivity.V1Beta.dll

Constructors

RemoteTransportProfileName(string, string, string)

public RemoteTransportProfileName(string projectId, string locationId, string remoteTransportProfileId)

Constructs a new instance of a RemoteTransportProfileName class from the component parts of pattern projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}

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

The RemoteTransportProfile ID. Must not be null or empty.

Properties

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

RemoteTransportProfileId

public string RemoteTransportProfileId { get; }

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

Property Value
Type Description
string

Type

public RemoteTransportProfileName.ResourceNameType Type { get; }

The RemoteTransportProfileName.ResourceNameType of the contained resource name.

Property Value
Type Description
RemoteTransportProfileNameResourceNameType

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

Formats the IDs into the string representation of this RemoteTransportProfileName with pattern projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}.

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

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

The string representation of this RemoteTransportProfileName with pattern projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}.

FormatProjectLocationRemoteTransportProfile(string, string, string)

public static string FormatProjectLocationRemoteTransportProfile(string projectId, string locationId, string remoteTransportProfileId)

Formats the IDs into the string representation of this RemoteTransportProfileName with pattern projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}.

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

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

The string representation of this RemoteTransportProfileName with pattern projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}.

FromProjectLocationRemoteTransportProfile(string, string, string)

public static RemoteTransportProfileName FromProjectLocationRemoteTransportProfile(string projectId, string locationId, string remoteTransportProfileId)

Creates a RemoteTransportProfileName with the pattern projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}.

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

The RemoteTransportProfile ID. Must not be null or empty.
Returns
Type Description
RemoteTransportProfileName

A new instance of RemoteTransportProfileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RemoteTransportProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RemoteTransportProfileName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
remoteTransportProfileName string

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

The parsed RemoteTransportProfileName if successful.
Remarks

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

  • projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}

Parse(string, bool)

public static RemoteTransportProfileName Parse(string remoteTransportProfileName, bool allowUnparsed)

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

Parameters
Name Description
remoteTransportProfileName 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
RemoteTransportProfileName

The parsed RemoteTransportProfileName if successful.
Remarks

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

  • projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}

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

public static bool TryParse(string remoteTransportProfileName, out RemoteTransportProfileName result)

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

Parameters
Name Description
remoteTransportProfileName string

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

When this method returns, the parsed RemoteTransportProfileName, 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}/remoteTransportProfiles/{remote_transport_profile}

TryParse(string, bool, out RemoteTransportProfileName)

public static bool TryParse(string remoteTransportProfileName, bool allowUnparsed, out RemoteTransportProfileName result)

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

Parameters
Name Description
remoteTransportProfileName 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 RemoteTransportProfileName

When this method returns, the parsed RemoteTransportProfileName, 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}/remoteTransportProfiles/{remote_transport_profile}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RemoteTransportProfileName, RemoteTransportProfileName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RemoteTransportProfileName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RemoteTransportProfileName

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

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.