Связаться с намиПодключиться

Cloud Functions Service, gRPC: FunctionService.Create

Статья создана
Обновлена 17 декабря 2024 г.

Creates a function in the specified folder.

gRPC request

rpc Create (CreateFunctionRequest) returns (operation.Operation)

CreateFunctionRequest

{
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>"
}

Field

Description

folder_id

string

Required field. ID of the folder to create a function in.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

name

string

Name of the function.
The name must be unique within the folder.

description

string

Description of the function.

labels

object (map<string, string>)

Resource labels as key:value pairs.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "function_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "http_invoke_url": "string",
    "status": "Status"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateFunctionMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Function

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateFunctionMetadata

Field

Description

function_id

string

ID of the function that is being created.

Function

A serverless function. For details about the concept, see Functions.

Field

Description

id

string

ID of the function. Generated at creation time.

folder_id

string

ID of the folder that the function belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp for the function.

name

string

Name of the function. The name is unique within the folder.

description

string

Description of the function.

labels

object (map<string, string>)

Function labels as key:value pairs.

http_invoke_url

string

URL that needs to be requested to invoke the function.

status

enum Status

Status of the function.

  • STATUS_UNSPECIFIED
  • CREATING: Function is being created.
  • ACTIVE: Function is ready to be invoked.
  • DELETING: Function is being deleted.
  • ERROR: Function failed.
Предыдущая
List
Следующая
Update