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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Format: |
↳ 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 |
Documentation
Optional. Documentation of the external API. |
↳ 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: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Creation timestamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Last update timestamp. |
getName
Identifier. Format:
projects/{project}/locations/{location}/externalApi/{externalApi}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Format:
projects/{project}/locations/{location}/externalApi/{externalApi}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpoints
Optional. List of endpoints on which this API is accessible.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEndpoints
Optional. List of endpoints on which this API is accessible.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPaths
Optional. List of paths served by this API.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPaths
Optional. List of paths served by this API.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentation
Optional. Documentation of the external API.
| Returns | |
|---|---|
| Type | Description |
Documentation|null |
|
hasDocumentation
clearDocumentation
setDocumentation
Optional. Documentation of the external API.
| Parameter | |
|---|---|
| Name | Description |
var |
Documentation
|
| 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 |
|
getCreateTime
Output only. Creation timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Last update timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|