Cloud Run Admin API (run:v1)

2022-01-29

14 new methods

Additions

    Methods
  • run.namespaces.executions.get

      Description: Get information about an execution.

      Path: apis/run.googleapis.com/v1/{+name}

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/executions/{executionsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      HTTP Method: GET

      Parameters:

        name

          Pattern: ^namespaces/[^/]+/executions/[^/]+$

          Location: path

          Description: Required. The name of the execution to retrieve. Replace {namespace_id} with the project ID or number.

          Required: Yes

          Type: string

  • run.namespaces.executions.delete

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Description: Delete an execution.

      Parameters:

        apiVersion

          Location: query

          Description: Optional. Cloud Run currently ignores this parameter.

          Type: string

        kind

          Type: string

          Location: query

          Description: Optional. Cloud Run currently ignores this parameter.

        propagationPolicy

          Location: query

          Type: string

          Description: Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.

        name

          Type: string

          Pattern: ^namespaces/[^/]+/executions/[^/]+$

          Location: path

          Description: Required. The name of the execution to delete. Replace {namespace_id} with the project ID or number.

          Required: Yes

      Path: apis/run.googleapis.com/v1/{+name}

      HTTP Method: DELETE

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/executions/{executionsId}

  • run.namespaces.executions.list

      Path: apis/run.googleapis.com/v1/{+parent}/executions

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/executions

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        continue

          Type: string

          Description: Optional. Optional encoded string to continue paging.

          Location: query

        watch

          Description: Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

          Location: query

          Type: boolean

        limit

          Location: query

          Type: integer

          Format: int32

          Description: Optional. The maximum number of records that should be returned.

        labelSelector

          Description: Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

          Type: string

          Location: query

        includeUninitialized

          Description: Optional. Not currently used by Cloud Run.

          Location: query

          Type: boolean

        fieldSelector

          Type: string

          Location: query

          Description: Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.

        parent

          Type: string

          Pattern: ^namespaces/[^/]+$

          Description: Required. The namespace from which the executions should be listed. Replace {namespace_id} with the project ID or number.

          Location: path

          Required: Yes

        resourceVersion

          Location: query

          Description: Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

          Type: string

      HTTP Method: GET

      Description: List executions.

      Parameter Order: parent

  • run.namespaces.jobs.run

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/jobs/{jobsId}:run

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: apis/run.googleapis.com/v1/{+name}:run

      Parameters:

        name

          Required: Yes

          Type: string

          Location: path

          Pattern: ^namespaces/[^/]+/jobs/[^/]+$

          Description: Required. The name of the job to run. Replace {namespace_id} with the project ID or number.

      HTTP Method: POST

      Description: Trigger creation of a new execution of this job.

  • run.namespaces.jobs.replaceJob

      Path: apis/run.googleapis.com/v1/{+name}

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/jobs/{jobsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: PUT

      Parameters:

        name

          Required: Yes

          Pattern: ^namespaces/[^/]+/jobs/[^/]+$

          Description: Required. The name of the service being replaced. Replace {namespace_id} with the project ID or number.

          Location: path

          Type: string

      Description: Replace a job. Only the spec and metadata labels and annotations are modifiable. After the Replace request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

      Parameter Order: name

  • run.namespaces.jobs.get

      Parameter Order: name

      Parameters:

        name

          Required: Yes

          Pattern: ^namespaces/[^/]+/jobs/[^/]+$

          Description: Required. The name of the job to retrieve. Replace {namespace_id} with the project ID or number.

          Type: string

          Location: path

      Description: Get information about a job.

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/jobs/{jobsId}

      HTTP Method: GET

      Path: apis/run.googleapis.com/v1/{+name}

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • run.namespaces.jobs.delete

      Path: apis/run.googleapis.com/v1/{+name}

      Parameter Order: name

      Parameters:

        propagationPolicy

          Location: query

          Description: Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.

          Type: string

        kind

          Location: query

          Description: Optional. Cloud Run currently ignores this parameter.

          Type: string

        apiVersion

          Location: query

          Type: string

          Description: Optional. Cloud Run currently ignores this parameter.

        name

          Description: Required. The name of the job to delete. Replace {namespace_id} with the project ID or number.

          Type: string

          Pattern: ^namespaces/[^/]+/jobs/[^/]+$

          Required: Yes

          Location: path

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Delete a job.

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/jobs/{jobsId}

  • run.namespaces.jobs.create

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/jobs

      Parameters:

        parent

          Type: string

          Description: Required. The namespace in which the job should be created. Replace {namespace_id} with the project ID or number.

          Pattern: ^namespaces/[^/]+$

          Location: path

          Required: Yes

      Description: Create a job.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      HTTP Method: POST

      Path: apis/run.googleapis.com/v1/{+parent}/jobs

  • run.namespaces.jobs.list

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      HTTP Method: GET

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/jobs

      Description: List jobs.

      Parameters:

        labelSelector

          Location: query

          Type: string

          Description: Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

        resourceVersion

          Description: Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

          Type: string

          Location: query

        parent

          Type: string

          Location: path

          Required: Yes

          Pattern: ^namespaces/[^/]+$

          Description: Required. The namespace from which the jobs should be listed. Replace {namespace_id} with the project ID or number.

        watch

          Type: boolean

          Description: Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

          Location: query

        includeUninitialized

          Type: boolean

          Location: query

          Description: Optional. Not currently used by Cloud Run.

        limit

          Type: integer

          Location: query

          Format: int32

          Description: Optional. The maximum number of records that should be returned.

        continue

          Type: string

          Description: Optional. Optional encoded string to continue paging.

          Location: query

        fieldSelector

          Type: string

          Location: query

          Description: Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.

      Path: apis/run.googleapis.com/v1/{+parent}/jobs

  • run.namespaces.tasks.list

      Parameters:

        parent

          Required: Yes

          Pattern: ^namespaces/[^/]+$

          Location: path

          Type: string

          Description: Required. The namespace from which the tasks should be listed. Replace {namespace_id} with the project ID or number.

        resourceVersion

          Location: query

          Description: Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

          Type: string

        labelSelector

          Description: Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

          Type: string

          Location: query

        fieldSelector

          Type: string

          Location: query

          Description: Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.

        continue

          Description: Optional. Optional encoded string to continue paging.

          Type: string

          Location: query

        includeUninitialized

          Type: boolean

          Description: Optional. Not currently used by Cloud Run.

          Location: query

        watch

          Location: query

          Description: Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

          Type: boolean

        limit

          Format: int32

          Location: query

          Description: Optional. The maximum number of records that should be returned.

          Type: integer

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: List tasks.

      HTTP Method: GET

      Parameter Order: parent

      Path: apis/run.googleapis.com/v1/{+parent}/tasks

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/tasks

  • run.namespaces.tasks.get

      Description: Get information about a task.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Flat Path: apis/run.googleapis.com/v1/namespaces/{namespacesId}/tasks/{tasksId}

      Path: apis/run.googleapis.com/v1/{+name}

      Parameters:

        name

          Pattern: ^namespaces/[^/]+/tasks/[^/]+$

          Required: Yes

          Type: string

          Location: path

          Description: Required. The name of the task to retrieve. Replace {namespace_id} with the project ID or number.

      HTTP Method: GET

  • run.projects.locations.jobs.getIamPolicy

      Parameters:

        resource

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$

          Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

          Type: string

          Required: Yes

        options.requestedPolicyVersion

          Location: query

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Type: integer

          Format: int32

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:getIamPolicy

      Description: Get the IAM Access Control policy currently in effect for the given job. This result does not include any inherited policies.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+resource}:getIamPolicy

      HTTP Method: GET

      Parameter Order: resource

  • run.projects.locations.jobs.testIamPermissions

      Parameters:

        resource

          Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$

          Location: path

          Type: string

          Required: Yes

          Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

      Path: v1/{+resource}:testIamPermissions

      HTTP Method: POST

      Parameter Order: resource

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:testIamPermissions

      Description: Returns permissions that a caller has on the specified job. There are no permissions required for making this API call.

  • run.projects.locations.jobs.setIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$

          Required: Yes

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:setIamPolicy

      HTTP Method: POST

      Description: Sets the IAM Access control policy for the specified job. Overwrites any existing policy.

      Path: v1/{+resource}:setIamPolicy

      Parameter Order: resource