Console
    Start free

    Google Cloud Api Hub V1 Client - Class Version (0.3.0)

    Reference documentation and code samples for the Google Cloud Api Hub V1 Client class Version.

    Represents a version of the API resource in API hub. This is also referred to as the API version.

    Generated from protobuf message google.cloud.apihub.v1.Version

    Namespace

    Google \ Cloud \ ApiHub \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ display_name
    string

    Required. The display name of the version.

    ↳ description
    string

    Optional. The description of the version.

    ↳ documentation
    Documentation

    Optional. The documentation of the version.

    ↳ specs
    array

    Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

    ↳ api_operations
    array

    Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

    ↳ definitions
    array

    Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

    ↳ deployments
    array

    Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}

    ↳ create_time
    Google\Protobuf\Timestamp

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

    ↳ update_time
    Google\Protobuf\Timestamp

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

    ↳ lifecycle
    AttributeValues

    Optional. The lifecycle of the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-lifecycle 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.

    ↳ compliance
    AttributeValues

    Optional. The compliance associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-compliance 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.

    ↳ accreditation
    AttributeValues

    Optional. The accreditations associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-accreditation 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.

    ↳ attributes
    array| Google\Protobuf\Internal\MapField

    Optional. The list of user defined attributes associated with the Version 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.

    ↳ selected_deployment
    string

    Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}

    ↳ source_metadata
    array< SourceMetadata >

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

    getName

    Identifier. The name of the version.

    Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

    Returns
    Type
    Description
    string

    setName

    Identifier. The name of the version.

    Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Required. The display name of the version.

    Returns
    Type
    Description
    string

    setDisplayName

    Required. The display name of the version.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Optional. The description of the version.

    Returns
    Type
    Description
    string

    setDescription

    Optional. The description of the version.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDocumentation

    Optional. The documentation of the version.

    Returns
    Type
    Description
    Documentation |null

    hasDocumentation

    clearDocumentation

    setDocumentation

    Optional. The documentation of the version.

    Parameter
    Name
    Description
    var
    Documentation
    Returns
    Type
    Description
    $this

    getSpecs

    Output only. The specs associated with this version.

    Note that an API version can be associated with multiple specs. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setSpecs

    Output only. The specs associated with this version.

    Note that an API version can be associated with multiple specs. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getApiOperations

    Output only. The operations contained in the API version.

    These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setApiOperations

    Output only. The operations contained in the API version.

    These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getDefinitions

    Output only. The definitions contained in the API version.

    These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setDefinitions

    Output only. The definitions contained in the API version.

    These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getDeployments

    Optional. The deployments linked to this API version.

    Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setDeployments

    Optional. The deployments linked to this API version.

    Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getCreateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getLifecycle

    Optional. The lifecycle of the API version.

    This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-lifecycle 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.

    Returns
    Type
    Description
    AttributeValues |null

    hasLifecycle

    clearLifecycle

    setLifecycle

    Optional. The lifecycle of the API version.

    This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-lifecycle 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.

    Parameter
    Name
    Description
    var
    AttributeValues
    Returns
    Type
    Description
    $this

    getCompliance

    Optional. The compliance associated with the API version.

    This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-compliance 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.

    Returns
    Type
    Description
    AttributeValues |null

    hasCompliance

    clearCompliance

    setCompliance

    Optional. The compliance associated with the API version.

    This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-compliance 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.

    Parameter
    Name
    Description
    var
    AttributeValues
    Returns
    Type
    Description
    $this

    getAccreditation

    Optional. The accreditations associated with the API version.

    This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-accreditation 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.

    Returns
    Type
    Description
    AttributeValues |null

    hasAccreditation

    clearAccreditation

    setAccreditation

    Optional. The accreditations associated with the API version.

    This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-accreditation 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.

    Parameter
    Name
    Description
    var
    AttributeValues
    Returns
    Type
    Description
    $this

    getAttributes

    Optional. The list of user defined attributes associated with the Version 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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setAttributes

    Optional. The list of user defined attributes associated with the Version 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.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getSelectedDeployment

    Optional. The selected deployment for a Version resource.

    This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}

    Returns
    Type
    Description
    string

    setSelectedDeployment

    Optional. The selected deployment for a Version resource.

    This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSourceMetadata

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setSourceMetadata

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

    Parameter
    Name
    Description
    var
    array< SourceMetadata >
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: