API hub API . projects . locations . apis . versions . definitions

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Get details about a definition in an API version.

Args:
  name: string, Required. The name of the definition to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` object is supported.
  "attributes": { # Optional. The list of user defined attributes associated with the definition 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.
    "a_key": { # The attribute values associated with resource.
      "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
      "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
        "values": [ # Required. The attribute values in case attribute data type is enum.
          { # The value that can be assigned to the attribute when the data type is enum.
            "description": "A String", # Optional. The detailed description of the allowed value.
            "displayName": "A String", # Required. The display name of the allowed value.
            "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
            "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
          },
        ],
      },
      "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
        "values": [ # Required. The attribute values in case attribute data type is string or JSON.
          "A String",
        ],
      },
      "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
        "values": [ # Required. The attribute values in case attribute data type is string or JSON.
          "A String",
        ],
      },
      "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
        "values": [ # Required. The attribute values in case attribute data type is string or JSON.
          "A String",
        ],
      },
    },
  },
  "createTime": "A String", # Output only. The time at which the definition was created.
  "name": "A String", # Identifier. The name of the definition. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
  "schema": { # The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the `definitions` section for OpenAPI 2.0 version and in `components.schemas` section for OpenAPI 3.0 and 3.1 version. # Output only. The value of a schema definition.
    "displayName": "A String", # Output only. The display name of the schema. This will map to the name of the schema in the spec.
    "rawValue": "A String", # Output only. The raw value of the schema definition corresponding to the schema name in the spec.
  },
  "spec": "A String", # Output only. The name of the spec from where the definition was parsed. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
  "type": "A String", # Output only. The type of the definition.
  "updateTime": "A String", # Output only. The time at which the definition was last updated.
}