pulumi-google-native-kotlin/com.pulumi.googlenative.apigeeregistry.v1.kotlin/DeploymentArgs

DeploymentArgs

data class DeploymentArgs(val accessGuidance: Output<String>? = null, val annotations: Output<Map<String, String>>? = null, val apiDeploymentId: Output<String>? = null, val apiId: Output<String>? = null, val apiSpecRevision: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val endpointUri: Output<String>? = null, val externalChannelUri: Output<String>? = null, val intendedAudience: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<DeploymentArgs>

Creates a specified deployment.

Constructors

DeploymentArgs

fun DeploymentArgs(accessGuidance: Output<String>? = null, annotations: Output<Map<String, String>>? = null, apiDeploymentId: Output<String>? = null, apiId: Output<String>? = null, apiSpecRevision: Output<String>? = null, description: Output<String>? = null, displayName: Output<String>? = null, endpointUri: Output<String>? = null, externalChannelUri: Output<String>? = null, intendedAudience: Output<String>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null)

Functions

toJava

open override fun toJava(): DeploymentArgs

Properties

accessGuidance

val accessGuidance: Output<String>? = null

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

annotations

val annotations: Output<Map<String, String>>? = null

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

apiDeploymentId

val apiDeploymentId: Output<String>? = null

Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.

apiId

val apiId: Output<String>? = null

apiSpecRevision

val apiSpecRevision: Output<String>? = null

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}

description

val description: Output<String>? = null

A detailed description.

displayName

val displayName: Output<String>? = null

Human-meaningful name.

endpointUri

val endpointUri: Output<String>? = null

The address where the deployment is serving. Changes to this value will update the revision.

externalChannelUri

val externalChannelUri: Output<String>? = null

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

intendedAudience

val intendedAudience: Output<String>? = null

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

labels

val labels: Output<Map<String, String>>? = null

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

location

val location: Output<String>? = null

name

val name: Output<String>? = null

Resource name.

project

val project: Output<String>? = null