Console
    Contact Us Start free

    REST Resource: projects.locations.dependencies

    Resource: Dependency

    A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API .

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "consumer" 
 : 
 { 
 object (  DependencyEntityReference 
 
) 
 } 
 , 
 "supplier" 
 : 
 { 
 object (  DependencyEntityReference 
 
) 
 } 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "description" 
 : 
 string 
 , 
 "discoveryMode" 
 : 
 enum (  DiscoveryMode 
 
) 
 , 
 "errorDetail" 
 : 
 { 
 object (  DependencyErrorDetail 
 
) 
 } 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "attributes" 
 : 
 { 
 string 
 : 
 { 
 object (  AttributeValues 
 
) 
 } 
 , 
 ... 
 } 
 }
    Fields
    name

    string

    Identifier. The name of the dependency in the API Hub.

    Format: projects/{project}/locations/{location}/dependencies/{dependency}

    consumer

    object ( DependencyEntityReference )

    Required. Immutable. The entity acting as the consumer in the dependency.
    supplier

    object ( DependencyEntityReference )

    Required. Immutable. The entity acting as the supplier in the dependency.
    state

    enum ( State )

    Output only. State of the dependency.
    description

    string

    Optional. Human readable description corresponding of the dependency.
    discoveryMode

    enum ( DiscoveryMode )

    Output only. Discovery mode of the dependency.
    errorDetail

    object ( DependencyErrorDetail )

    Output only. Error details of a dependency if the system has detected it internally.
    createTime

    string ( Timestamp format)

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

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

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

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    attributes

    map (key: string, value: object ( AttributeValues ))

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

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    DependencyEntityReference

    Reference to an entity participating in a dependency.

    JSON representation 
     { 
 "displayName" 
 : 
 string 
 , 
 // Union field identifier 
can be only one of the following: 
 "operationResourceName" 
 : 
 string 
 , 
 "externalApiResourceName" 
 : 
 string 
 // End of list of possible types for union field identifier 
. 
 }
    Fields
    displayName

    string

    Output only. Display name of the entity.

    Union field identifier . Required. Unique identifier for the participating entity. identifier can be only one of the following:
    operationResourceName

    string

    The resource name of an operation in the API Hub.

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

    externalApiResourceName

    string

    The resource name of an external API in the API Hub.

    Format: projects/{project}/locations/{location}/externalApis/{externalApi}

    State

    Possible states for a dependency.

    Enums
    STATE_UNSPECIFIED Default value. This value is unused.
    PROPOSED Dependency will be in a proposed state when it is newly identified by the API hub on its own.
    VALIDATED Dependency will be in a validated state when it is validated by the admin or manually created in the API hub.

    DiscoveryMode

    Possible modes of discovering the dependency.

    Enums
    DISCOVERY_MODE_UNSPECIFIED Default value. This value is unused.
    MANUAL Manual mode of discovery when the dependency is defined by the user.

    DependencyErrorDetail

    Details describing error condition of a dependency.

    JSON representation 
     { 
 "error" 
 : 
 enum (  Error 
 
) 
 , 
 "errorTime" 
 : 
 string 
 }
    Fields
    error

    enum ( Error )

    Optional. Error in the dependency.
    errorTime

    string ( Timestamp format)

    Optional. Timestamp at which the error was found.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    Error

    Possible values representing an error in the dependency.

    Enums
    ERROR_UNSPECIFIED Default value used for no error in the dependency.
    SUPPLIER_NOT_FOUND Supplier entity has been deleted.
    SUPPLIER_RECREATED Supplier entity has been recreated.

    Methods

    create

    		Create a dependency between two entities in the API hub.

    delete

    		Delete the dependency resource.

    get

    		Get details about a dependency resource in the API hub.

    list

    		List dependencies based on the provided filter and pagination parameters.

    patch

    		Update a dependency based on the update_mask provided in the request.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: