public sealed class ApiSpecName : IResourceName, IEquatable<ApiSpecName>
Reference documentation and code samples for the Apigee Registry v1 API class ApiSpecName.
Resource name for the ApiSpec
resource.
Namespace
Google.Cloud.ApigeeRegistry.V1Assembly
Google.Cloud.ApigeeRegistry.V1.dll
Constructors
ApiSpecName(string, string, string, string, string)
public ApiSpecName(string projectId, string locationId, string apiId, string versionId, string specId)
Constructs a new instance of a ApiSpecName class from the component parts of pattern
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
apiId |
string The |
versionId |
string The |
specId |
string The |
Properties
ApiId
public string ApiId { get; }
The Api
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 |
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 |
SpecId
public string SpecId { get; }
The Spec
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public ApiSpecName.ResourceNameType Type { get; }
The ApiSpecName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ApiSpecNameResourceNameType |
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained UnparsedResourceName. Only non-null
if this instance contains an
unparsed resource name.
Property Value | |
---|---|
Type | Description |
UnparsedResourceName |
VersionId
public string VersionId { get; }
The Version
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Methods
Format(string, string, string, string, string)
public static string Format(string projectId, string locationId, string apiId, string versionId, string specId)
Formats the IDs into the string representation of this ApiSpecName with pattern
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
apiId |
string The |
versionId |
string The |
specId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ApiSpecName with pattern
|
FormatProjectLocationApiVersionSpec(string, string, string, string, string)
public static string FormatProjectLocationApiVersionSpec(string projectId, string locationId, string apiId, string versionId, string specId)
Formats the IDs into the string representation of this ApiSpecName with pattern
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
apiId |
string The |
versionId |
string The |
specId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ApiSpecName with pattern
|
FromProjectLocationApiVersionSpec(string, string, string, string, string)
public static ApiSpecName FromProjectLocationApiVersionSpec(string projectId, string locationId, string apiId, string versionId, string specId)
Creates a ApiSpecName with the pattern
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
apiId |
string The |
versionId |
string The |
specId |
string The |
Returns | |
---|---|
Type | Description |
ApiSpecName |
A new instance of ApiSpecName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static ApiSpecName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a ApiSpecName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ApiSpecName |
A new instance of ApiSpecName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static ApiSpecName Parse(string apiSpecName)
Parses the given resource name string into a new ApiSpecName instance.
Parameter | |
---|---|
Name | Description |
apiSpecName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ApiSpecName |
The parsed ApiSpecName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
Parse(string, bool)
public static ApiSpecName Parse(string apiSpecName, bool allowUnparsed)
Parses the given resource name string into a new ApiSpecName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
apiSpecName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
ApiSpecName |
The parsed ApiSpecName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
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 ApiSpecName)
public static bool TryParse(string apiSpecName, out ApiSpecName result)
Tries to parse the given resource name string into a new ApiSpecName instance.
Parameters | |
---|---|
Name | Description |
apiSpecName |
string The resource name in string form. Must not be |
result |
ApiSpecName When this method returns, the parsed ApiSpecName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
TryParse(string, bool, out ApiSpecName)
public static bool TryParse(string apiSpecName, bool allowUnparsed, out ApiSpecName result)
Tries to parse the given resource name string into a new ApiSpecName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
apiSpecName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
ApiSpecName When this method returns, the parsed ApiSpecName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
allowUnparsed
is true
.
Operators
operator ==(ApiSpecName, ApiSpecName)
public static bool operator ==(ApiSpecName a, ApiSpecName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
ApiSpecName The first resource name to compare, or null. |
b |
ApiSpecName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(ApiSpecName, ApiSpecName)
public static bool operator !=(ApiSpecName a, ApiSpecName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
ApiSpecName The first resource name to compare, or null. |
b |
ApiSpecName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |