Google Cloud Api Hub V1 Client - Class CreateApiOperationRequest (0.4.1)

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

The CreateApiOperation method's request.

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

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 operation resource. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}
↳ api_operation_id string

Optional. The ID to use for the operation resource, which will become the final component of the operation'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 operation resource in the API hub. * * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}, its length is limited to 700 characters, and valid characters are /[a-z][A-Z][0-9]-_/.
↳ api_operation ApiOperation

Required. The operation resource to create.

getParent

Required. The parent resource for the operation resource.

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

Returns
Type Description
string

setParent

Required. The parent resource for the operation resource.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getApiOperationId

Optional. The ID to use for the operation resource, which will become the final component of the operation'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 operation resource in the API hub.
  • If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}, its length is limited to 700 characters, and valid characters are /[a-z][A-Z][0-9]-_/.
Returns
Type Description
string

setApiOperationId

Optional. The ID to use for the operation resource, which will become the final component of the operation'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 operation resource in the API hub.
  • If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}, its length is limited to 700 characters, and valid characters are /[a-z][A-Z][0-9]-_/.
Parameter
Name Description
var string
Returns
Type Description
$this

getApiOperation

Required. The operation resource to create.

Returns
Type Description
ApiOperation|null

hasApiOperation

clearApiOperation

setApiOperation

Required. The operation resource to create.

Parameter
Name Description
var ApiOperation
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent resource for the operation resource. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version} Please see ApiHubClient::versionName() for help formatting this field.
apiOperation ApiOperation

Required. The operation resource to create.
apiOperationId string

Optional. The ID to use for the operation resource, which will become the final component of the operation'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 operation resource in the API hub.
    • If not provided, a system generated id will be used.

This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}, its length is limited to 700 characters, and valid characters are /[a-z][A-Z][0-9]-_/.
Returns
Type Description
CreateApiOperationRequest