Class GoogleCloudApihubV1Deployment

Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.

Inheritance

object

GoogleCloudApihubV1Deployment

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.APIhub.v1.Data

Assembly: Google.Apis.APIhub.v1.dll

Syntax

public class GoogleCloudApihubV1Deployment : IDirectResponseSchema

Properties

ApiVersions

Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).

Declaration

[JsonProperty("apiVersions")]
public virtual IList<string> ApiVersions { get; set; }

Property Value

Type	Description
IList<string>

Attributes

Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

Declaration

[JsonProperty("attributes")]
public virtual IDictionary<string, GoogleCloudApihubV1AttributeValues> Attributes { get; set; }

Property Value

Type	Description
IDictionary<string, GoogleCloudApihubV1AttributeValues>

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. The time at which the deployment was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

DeploymentType

Required. The type of deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-deployment-type attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Declaration

[JsonProperty("deploymentType")]
public virtual GoogleCloudApihubV1AttributeValues DeploymentType { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

Description

Optional. The description of the deployment.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DisplayName

Required. The display name of the deployment.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

Documentation

Optional. The documentation of the deployment.

Declaration

[JsonProperty("documentation")]
public virtual GoogleCloudApihubV1Documentation Documentation { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1Documentation

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Endpoints

Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.

Declaration

[JsonProperty("endpoints")]
public virtual IList<string> Endpoints { get; set; }

Property Value

Type	Description
IList<string>

Environment

Optional. The environment mapping to this deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-environment attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Declaration

[JsonProperty("environment")]
public virtual GoogleCloudApihubV1AttributeValues Environment { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

ManagementUrl

Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-management-url The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.

Declaration

[JsonProperty("managementUrl")]
public virtual GoogleCloudApihubV1AttributeValues ManagementUrl { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

Name

Identifier. The name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ResourceUri

Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name orders is deployed in staging environment of cymbal organization, the resource URI would be: organizations/cymbal/environments/staging/apis/orders.

Declaration

[JsonProperty("resourceUri")]
public virtual string ResourceUri { get; set; }

Property Value

Type	Description
string

Slo

Optional. The SLO for this deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-slo attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Declaration

[JsonProperty("slo")]
public virtual GoogleCloudApihubV1AttributeValues Slo { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

SourceEnvironment

Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.

Declaration

[JsonProperty("sourceEnvironment")]
public virtual string SourceEnvironment { get; set; }

Property Value

Type	Description
string

SourceMetadata

Output only. The list of sources and metadata from the sources of the deployment.

Declaration

[JsonProperty("sourceMetadata")]
public virtual IList<GoogleCloudApihubV1SourceMetadata> SourceMetadata { get; set; }

Property Value

Type	Description
IList<GoogleCloudApihubV1SourceMetadata>

SourceProject

Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.

Declaration

[JsonProperty("sourceProject")]
public virtual string SourceProject { get; set; }

Property Value

Type	Description
string

SourceUri

Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-source-uri The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

Declaration

[JsonProperty("sourceUri")]
public virtual GoogleCloudApihubV1AttributeValues SourceUri { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. The time at which the deployment was last updated.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema