Apigee Registry v1 API - Class ApiDeploymentName (1.0.0-beta07) 

public sealed class ApiDeploymentName : IResourceName, IEquatable<ApiDeploymentName>

Reference documentation and code samples for the Apigee Registry v1 API class ApiDeploymentName.

Resource name for the ApiDeployment resource.

Inheritance

object > ApiDeploymentName

Namespace

Google.Cloud.ApigeeRegistry.V1

Assembly

Google.Cloud.ApigeeRegistry.V1.dll

Constructors

ApiDeploymentName(string, string, string, string)

public ApiDeploymentName(string projectId, string locationId, string apiId, string deploymentId)

Constructs a new instance of a ApiDeploymentName class from the component parts of pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

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.
deploymentId string

The Deployment 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

DeploymentId

public string DeploymentId { get; }

The Deployment 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 ApiDeploymentName.ResourceNameType Type { get; }

The ApiDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type Description
ApiDeploymentNameResourceNameType

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

public static string Format(string projectId, string locationId, string apiId, string deploymentId)

Formats the IDs into the string representation of this ApiDeploymentName with pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}.

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.
deploymentId string

The Deployment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ApiDeploymentName with pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}.

FormatProjectLocationApiDeployment(string, string, string, string)

public static string FormatProjectLocationApiDeployment(string projectId, string locationId, string apiId, string deploymentId)

Formats the IDs into the string representation of this ApiDeploymentName with pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}.

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.
deploymentId string

The Deployment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ApiDeploymentName with pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}.

FromProjectLocationApiDeployment(string, string, string, string)

public static ApiDeploymentName FromProjectLocationApiDeployment(string projectId, string locationId, string apiId, string deploymentId)

Creates a ApiDeploymentName with the pattern projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}.

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.
deploymentId string

The Deployment ID. Must not be null or empty.
Returns
Type Description
ApiDeploymentName

A new instance of ApiDeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ApiDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ApiDeploymentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ApiDeploymentName

A new instance of ApiDeploymentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ApiDeploymentName Parse(string apiDeploymentName)

Parses the given resource name string into a new ApiDeploymentName instance.

Parameter
Name Description
apiDeploymentName string

The resource name in string form. Must not be null.
Returns
Type Description
ApiDeploymentName

The parsed ApiDeploymentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

Parse(string, bool)

public static ApiDeploymentName Parse(string apiDeploymentName, bool allowUnparsed)

Parses the given resource name string into a new ApiDeploymentName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
apiDeploymentName string

The resource name in string form. Must not be null.
allowUnparsed bool

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
ApiDeploymentName

The parsed ApiDeploymentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
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

TryParse(string, out ApiDeploymentName)

public static bool TryParse(string apiDeploymentName, out ApiDeploymentName result)

Tries to parse the given resource name string into a new ApiDeploymentName instance.

Parameters
Name Description
apiDeploymentName string

The resource name in string form. Must not be null.
result ApiDeploymentName

When this method returns, the parsed ApiDeploymentName, or null if parsing failed.
Returns
Type Description
bool

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}/deployments/{deployment}

TryParse(string, bool, out ApiDeploymentName)

public static bool TryParse(string apiDeploymentName, bool allowUnparsed, out ApiDeploymentName result)

Tries to parse the given resource name string into a new ApiDeploymentName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
apiDeploymentName string

The resource name in string form. Must not be null.
allowUnparsed bool

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 ApiDeploymentName

When this method returns, the parsed ApiDeploymentName, or null if parsing failed.
Returns
Type Description
bool

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}/deployments/{deployment}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ApiDeploymentName, ApiDeploymentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ApiDeploymentName

The first resource name to compare, or null.
b ApiDeploymentName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ApiDeploymentName, ApiDeploymentName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ApiDeploymentName

The first resource name to compare, or null.
b ApiDeploymentName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.