API hub v1 API - Class PluginName (1.0.0-beta02) 

public sealed class PluginName : IResourceName, IEquatable<PluginName>

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

Resource name for the Plugin resource.

Inheritance

object > PluginName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

PluginName(string, string, string)

public PluginName(string projectId, string locationId, string pluginId)

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

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.

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

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

The PluginName.ResourceNameType of the contained resource name.

Property Value
Type Description
PluginNameResourceNameType

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

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

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.
Returns
Type Description
string

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

FormatProjectLocationPlugin(string, string, string)

public static string FormatProjectLocationPlugin(string projectId, string locationId, string pluginId)

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

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.
Returns
Type Description
string

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

FromProjectLocationPlugin(string, string, string)

public static PluginName FromProjectLocationPlugin(string projectId, string locationId, string pluginId)

Creates a PluginName with the pattern projects/{project}/locations/{location}/plugins/{plugin}.

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.
Returns
Type Description
PluginName

A new instance of PluginName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PluginName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PluginName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
pluginName string

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

The parsed PluginName if successful.
Remarks

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

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

Parse(string, bool)

public static PluginName Parse(string pluginName, bool allowUnparsed)

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

Parameters
Name Description
pluginName 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
PluginName

The parsed PluginName if successful.
Remarks

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

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

public static bool TryParse(string pluginName, out PluginName result)

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

Parameters
Name Description
pluginName string

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

When this method returns, the parsed PluginName, 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}

TryParse(string, bool, out PluginName)

public static bool TryParse(string pluginName, bool allowUnparsed, out PluginName result)

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

Parameters
Name Description
pluginName 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 PluginName

When this method returns, the parsed PluginName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PluginName, PluginName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PluginName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PluginName

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

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.