Apigee Registry v1 API - Class ApiSpecName (1.0.0-beta04)

Version 1.0.0-beta04

• 1.0.0-beta07 (latest)
• 1.0.0-beta06

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.

Inheritance

Object > ApiSpecName

Implements

IResourceName, IEquatable<ApiSpecName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.ApigeeRegistry.V1

Assembly

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 Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
apiId	String The Api ID. Must not be null or empty.
versionId	String The Version ID. Must not be null or empty.
specId	String The Spec ID. Must not be null or empty.

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
Boolean

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
ApiSpecName.ResourceNameType

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 Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
apiId	String The Api ID. Must not be null or empty.
versionId	String The Version ID. Must not be null or empty.
specId	String The Spec ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this ApiSpecName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}.

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 Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
apiId	String The Api ID. Must not be null or empty.
versionId	String The Version ID. Must not be null or empty.
specId	String The Spec ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this ApiSpecName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}.

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 Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
apiId	String The Api ID. Must not be null or empty.
versionId	String The Version ID. Must not be null or empty.
specId	String The Spec ID. Must not be null or empty.

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 null.

Returns
Type	Description
ApiSpecName	A new instance of ApiSpecName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
Int32

Overrides

Object.GetHashCode()

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 null.

Returns
Type	Description
ApiSpecName	The parsed ApiSpecName if successful.

Remarks

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, Boolean)

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 null.
allowUnparsed	Boolean If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
ApiSpecName	The parsed ApiSpecName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

Or may be in any format if 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.

Overrides

Object.ToString()

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 null.
result	ApiSpecName When this method returns, the parsed ApiSpecName, or null if parsing failed.

Returns
Type	Description
Boolean	true if the name was parsed successfully; false otherwise.

Remarks

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, Boolean, 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 null.
allowUnparsed	Boolean If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result	ApiSpecName When this method returns, the parsed ApiSpecName, or null if parsing failed.

Returns
Type	Description
Boolean	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ApiSpecName, ApiSpecName)

public static bool operator ==(ApiSpecName a, ApiSpecName b)

Parameters
Name	Description
a	ApiSpecName
b	ApiSpecName

Returns
Type	Description
Boolean

Inequality(ApiSpecName, ApiSpecName)

public static bool operator !=(ApiSpecName a, ApiSpecName b)

Parameters
Name	Description
a	ApiSpecName
b	ApiSpecName

Returns
Type	Description
Boolean