Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ExternalApi.
An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
Generated from protobuf message google.cloud.apihub.v1.ExternalApi
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}
.
↳ display_name
string
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
↳ description
string
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
↳ endpoints
array
Optional. List of endpoints on which this API is accessible.
↳ paths
array
Optional. List of paths served by this API.
↳ documentation
↳ 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.
↳ create_time
↳ update_time
getName
Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}
.
string
setName
Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}
.
var
string
$this
getDisplayName
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
string
setDisplayName
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
var
string
$this
getDescription
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
string
setDescription
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
var
string
$this
getEndpoints
Optional. List of endpoints on which this API is accessible.
setEndpoints
Optional. List of endpoints on which this API is accessible.
var
string[]
$this
getPaths
Optional. List of paths served by this API.
setPaths
Optional. List of paths served by this API.
var
string[]
$this
getDocumentation
Optional. Documentation of the external API.
hasDocumentation
clearDocumentation
setDocumentation
Optional. Documentation of the external API.
$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.
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.
$this
getCreateTime
Output only. Creation timestamp.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation timestamp.
$this
getUpdateTime
Output only. Last update timestamp.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update timestamp.
$this
