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.
Namespace
Google.Cloud.ApiHub.V1Assembly
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 |
locationId |
string The |
pluginId |
string The |
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 |
locationId |
string The |
pluginId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this PluginName with pattern
|
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 |
locationId |
string The |
pluginId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this PluginName with pattern
|
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 |
locationId |
string The |
pluginId |
string The |
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 |
Returns | |
---|---|
Type | Description |
PluginName |
A new instance of PluginName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
PluginName |
The parsed PluginName if successful. |
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 |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
PluginName |
The parsed PluginName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/plugins/{plugin}
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. |
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 |
result |
PluginName When this method returns, the parsed PluginName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed |
bool If |
result |
PluginName When this method returns, the parsed PluginName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/plugins/{plugin}
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 |
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 |