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