Console
    Start free

    Google Cloud Api Hub V1 Client - Class Deployment (0.1.4)

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

    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.

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

    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 deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

    ↳ display_name
    string

    Required. The display name of the deployment.

    ↳ description
    string

    Optional. The description of the deployment.

    ↳ documentation
    Documentation

    Optional. The documentation of the deployment.

    ↳ deployment_type
    AttributeValues

    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.

    ↳ resource_uri
    string

    Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.

    ↳ endpoints
    array

    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.

    ↳ api_versions
    array

    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).

    ↳ create_time
    Google\Protobuf\Timestamp

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

    ↳ update_time
    Google\Protobuf\Timestamp

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

    ↳ slo
    AttributeValues

    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.

    ↳ environment
    AttributeValues

    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.

    ↳ attributes
    array| Google\Protobuf\Internal\MapField

    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.

    getName

    Identifier. The name of the deployment.

    Format: projects/{project}/locations/{location}/deployments/{deployment}

    Returns
    Type
    Description
    string

    setName

    Identifier. The name of the deployment.

    Format: projects/{project}/locations/{location}/deployments/{deployment}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Required. The display name of the deployment.

    Returns
    Type
    Description
    string

    setDisplayName

    Required. The display name of the deployment.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Optional. The description of the deployment.

    Returns
    Type
    Description
    string

    setDescription

    Optional. The description of the deployment.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDocumentation

    Optional. The documentation of the deployment.

    Returns
    Type
    Description
    Documentation |null

    hasDocumentation

    clearDocumentation

    setDocumentation

    Optional. The documentation of the deployment.

    Parameter
    Name
    Description
    var
    Documentation
    Returns
    Type
    Description
    $this

    getDeploymentType

    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.

    Returns
    Type
    Description
    AttributeValues |null

    hasDeploymentType

    clearDeploymentType

    setDeploymentType

    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.

    Parameter
    Name
    Description
    var
    AttributeValues
    Returns
    Type
    Description
    $this

    getResourceUri

    Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.

    Returns
    Type
    Description
    string

    setResourceUri

    Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getEndpoints

    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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setEndpoints

    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.

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

    getApiVersions

    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).

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setApiVersions

    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).

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

    getCreateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

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

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

    getUpdateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

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

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

    getSlo

    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.

    Returns
    Type
    Description
    AttributeValues |null

    hasSlo

    clearSlo

    setSlo

    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.

    Parameter
    Name
    Description
    var
    AttributeValues
    Returns
    Type
    Description
    $this

    getEnvironment

    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.

    Returns
    Type
    Description
    AttributeValues |null

    hasEnvironment

    clearEnvironment

    setEnvironment

    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.

    Parameter
    Name
    Description
    var
    AttributeValues
    Returns
    Type
    Description
    $this

    getAttributes

    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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setAttributes

    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.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: