Google Cloud Api Hub V1 Client - Class CreateExternalApiRequest (0.1.3)

Version latest

• 0.1.3 (latest)
• 0.1.2

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

The CreateExternalApi method's request.

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

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent resource for the External API resource. Format: projects/{project}/locations/{location}
↳ external_api_id	string Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. * * If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. * * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.
↳ external_api	ExternalApi Required. The External API resource to create.

getParent

Required. The parent resource for the External API resource.

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

Returns
Type	Description
string

setParent

Required. The parent resource for the External API resource.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getExternalApiId

Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.

• If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub.
• If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

Returns
Type	Description
string

setExternalApiId

Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.

• If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub.
• If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getExternalApi

Required. The External API resource to create.

Returns
Type	Description
ExternalApi|null

hasExternalApi

clearExternalApi

setExternalApi

Required. The External API resource to create.

Parameter
Name	Description
var	ExternalApi

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. The parent resource for the External API resource. Format: projects/{project}/locations/{location} Please see ApiHubClient::locationName() for help formatting this field.
externalApi	ExternalApi Required. The External API resource to create.
externalApiId	string Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

Returns
Type	Description
CreateExternalApiRequest