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