public sealed class ConfigName : IResourceName, IEquatable<ConfigName>
Reference documentation and code samples for the Google Cloud Deploy v1 API class ConfigName.
Resource name for the Config
resource.
Namespace
Google.Cloud.Deploy.V1Assembly
Google.Cloud.Deploy.V1.dll
Constructors
ConfigName(string, string)
public ConfigName(string projectId, string locationId)
Constructs a new instance of a ConfigName class from the component parts of pattern
projects/{project}/locations/{location}/config
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | 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 |
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 ConfigName.ResourceNameType Type { get; }
The ConfigName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ConfigNameResourceNameType |
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 locationId)
Formats the IDs into the string representation of this ConfigName with pattern
projects/{project}/locations/{location}/config
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this ConfigName with pattern
|
FormatProjectLocation(string, string)
public static string FormatProjectLocation(string projectId, string locationId)
Formats the IDs into the string representation of this ConfigName with pattern
projects/{project}/locations/{location}/config
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this ConfigName with pattern
|
FromProjectLocation(string, string)
public static ConfigName FromProjectLocation(string projectId, string locationId)
Creates a ConfigName with the pattern projects/{project}/locations/{location}/config
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
Returns | |
---|---|
Type | Description |
ConfigName | A new instance of ConfigName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static ConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a ConfigName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ConfigName | A new instance of ConfigName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static ConfigName Parse(string configName)
Parses the given resource name string into a new ConfigName instance.
Parameter | |
---|---|
Name | Description |
configName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ConfigName | The parsed ConfigName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/config
Parse(string, bool)
public static ConfigName Parse(string configName, bool allowUnparsed)
Parses the given resource name string into a new ConfigName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
configName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
ConfigName | The parsed ConfigName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/config
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 ConfigName)
public static bool TryParse(string configName, out ConfigName result)
Tries to parse the given resource name string into a new ConfigName instance.
Parameters | |
---|---|
Name | Description |
configName | string The resource name in string form. Must not be |
result | ConfigName When this method returns, the parsed ConfigName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/config
TryParse(string, bool, out ConfigName)
public static bool TryParse(string configName, bool allowUnparsed, out ConfigName result)
Tries to parse the given resource name string into a new ConfigName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
configName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | ConfigName When this method returns, the parsed ConfigName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/config
allowUnparsed
is true
.
Operators
operator ==(ConfigName, ConfigName)
public static bool operator ==(ConfigName a, ConfigName b)
Parameters | |
---|---|
Name | Description |
a | ConfigName |
b | ConfigName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(ConfigName, ConfigName)
public static bool operator !=(ConfigName a, ConfigName b)
Parameters | |
---|---|
Name | Description |
a | ConfigName |
b | ConfigName |
Returns | |
---|---|
Type | Description |
bool |