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

ApiArgs

data class ApiArgs(val annotations: Output<Map<String, String>>? = null, val apiId: Output<String>? = null, val availability: Output<String>? = null, val description: Output<String>? = null, val displayName: 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, val recommendedDeployment: Output<String>? = null, val recommendedVersion: Output<String>? = null) : ConvertibleToJava<ApiArgs>

Creates a specified API.

Constructors

Link copied to clipboard
fun ApiArgs(annotations: Output<Map<String, String>>? = null, apiId: Output<String>? = null, availability: Output<String>? = null, description: Output<String>? = null, displayName: Output<String>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, recommendedDeployment: Output<String>? = null, recommendedVersion: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ApiArgs

Properties

Link copied to clipboard
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.

Link copied to clipboard
val apiId: Output<String>? = null

Required. The ID to use for the API, which will become the final component of the API'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.

Link copied to clipboard
val availability: Output<String>? = null

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

Link copied to clipboard
val description: Output<String>? = null

A detailed description.

Link copied to clipboard
val displayName: Output<String>? = null

Human-meaningful name.

Link copied to clipboard
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.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val name: Output<String>? = null

Resource name.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val recommendedDeployment: Output<String>? = null

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

Link copied to clipboard
val recommendedVersion: Output<String>? = null

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}