API hub v1 API - Class PluginInstanceName (1.1.0) 

public sealed class PluginInstanceName : IResourceName, IEquatable<PluginInstanceName>

Reference documentation and code samples for the API hub v1 API class PluginInstanceName.

Resource name for the PluginInstance resource.

Inheritance

object > PluginInstanceName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

PluginInstanceName(string, string, string, string)

public PluginInstanceName(string projectId, string locationId, string pluginId, string instanceId)

Constructs a new instance of a PluginInstanceName class from the component parts of pattern projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

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

The Plugin ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.

Properties

InstanceId

public string InstanceId { get; }

The Instance 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

PluginId

public string PluginId { get; }

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

The PluginInstanceName.ResourceNameType of the contained resource name.

Property Value
Type Description
PluginInstanceNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string pluginId, string instanceId)

Formats the IDs into the string representation of this PluginInstanceName with pattern projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.

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

The Plugin ID. Must not be null or empty.
instanceId string

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

The string representation of this PluginInstanceName with pattern projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.

FormatProjectLocationPluginInstance(string, string, string, string)

public static string FormatProjectLocationPluginInstance(string projectId, string locationId, string pluginId, string instanceId)

Formats the IDs into the string representation of this PluginInstanceName with pattern projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.

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

The Plugin ID. Must not be null or empty.
instanceId string

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

The string representation of this PluginInstanceName with pattern projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.

FromProjectLocationPluginInstance(string, string, string, string)

public static PluginInstanceName FromProjectLocationPluginInstance(string projectId, string locationId, string pluginId, string instanceId)

Creates a PluginInstanceName with the pattern projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.

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

The Plugin ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
Returns
Type Description
PluginInstanceName

A new instance of PluginInstanceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PluginInstanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PluginInstanceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
pluginInstanceName string

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

The parsed PluginInstanceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

Parse(string, bool)

public static PluginInstanceName Parse(string pluginInstanceName, bool allowUnparsed)

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

Parameters
Name Description
pluginInstanceName 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
PluginInstanceName

The parsed PluginInstanceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
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 PluginInstanceName)

public static bool TryParse(string pluginInstanceName, out PluginInstanceName result)

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

Parameters
Name Description
pluginInstanceName string

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

When this method returns, the parsed PluginInstanceName, 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}/plugins/{plugin}/instances/{instance}

TryParse(string, bool, out PluginInstanceName)

public static bool TryParse(string pluginInstanceName, bool allowUnparsed, out PluginInstanceName result)

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

Parameters
Name Description
pluginInstanceName 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 PluginInstanceName

When this method returns, the parsed PluginInstanceName, 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}/plugins/{plugin}/instances/{instance}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PluginInstanceName, PluginInstanceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PluginInstanceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PluginInstanceName

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

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.