Cloud Run Admin API (run:v2)

2022-01-06

12 new methods | New API

Additions

    Methods
  • run.projects.locations.operations.delete

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

      Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      Parameters:

        name

          Type: string

          Location: path

          Description: The name of the operation resource to be deleted.

          Required: Yes

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

      HTTP Method: DELETE

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Path: v2/{+name}

      Parameter Order: name

  • run.projects.locations.operations.get

      Path: v2/{+name}

      HTTP Method: GET

      Parameter Order: name

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

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

      Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Parameters:

        name

          Description: The name of the operation resource.

          Location: path

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

          Required: Yes

          Type: string

  • run.projects.locations.operations.list

      Parameter Order: name

      Parameters:

        pageSize

          Type: integer

          Format: int32

          Description: The standard list page size.

          Location: query

        name

          Type: string

          Description: The name of the operation's parent resource.

          Required: Yes

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

          Location: path

        filter

          Location: query

          Description: The standard list filter.

          Type: string

        pageToken

          Type: string

          Description: The standard list page token.

          Location: query

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations

      HTTP Method: GET

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

      Path: v2/{+name}/operations

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

  • run.projects.locations.services.patch

      Path: v2/{+name}

      Parameters:

        name

          Required: Yes

          Type: string

          Location: path

          Description: The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}

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

        allowMissing

          Type: boolean

          Location: query

          Description: / If set to true, and if the Service does not exist, it will create a new one. Caller must have both create and update permissions for this call if this is set to true.

        updateMask

          Description: The list of fields to be updated.

          Location: query

          Type: string

          Format: google-fieldmask

        validateOnly

          Description: Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.

          Location: query

          Type: boolean

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

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

      HTTP Method: PATCH

      Description: Updates a Service.

      Parameter Order: name

  • run.projects.locations.services.delete

      Path: v2/{+name}

      Parameters:

        name

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

          Description: Required. The full name of the Service. Format: projects/{projectnumber}/locations/{location}/services/{service}

          Location: path

          Type: string

          Required: Yes

        validateOnly

          Description: Indicates that the request should be validated without actually deleting any resources.

          Location: query

          Type: boolean

        etag

          Description: A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

          Type: string

          Location: query

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

      HTTP Method: DELETE

      Description: Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

      Parameter Order: name

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

  • run.projects.locations.services.undelete

      Parameters:

        name

          Description: Required. The full name of the Service. Format: projects/{projectnumber}/locations/{location}/services/{service}

          Type: string

          Required: Yes

          Location: path

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

      Parameter Order: name

      HTTP Method: POST

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:undelete

      Description: Undeletes a Service.

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

      Path: v2/{+name}:undelete

  • run.projects.locations.services.testIamPermissions

      Parameters:

        resource

          Location: path

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

          Type: string

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

          Required: Yes

      Parameter Order: resource

      Path: v2/{+resource}:testIamPermissions

      HTTP Method: POST

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

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:testIamPermissions

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

  • run.projects.locations.services.create

      HTTP Method: POST

      Path: v2/{+parent}/services

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services

      Description: Creates a new Service in a given project and location.

      Parameter Order: parent

      Parameters:

        validateOnly

          Type: boolean

          Description: Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.

          Location: query

        parent

          Type: string

          Location: path

          Description: Required. The location and project in which this service should be created. Format: projects/{projectnumber}/locations/{location}

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

          Required: Yes

        serviceId

          Description: Required. The unique identifier for the Service. The name of the service becomes {parent}/services/{service_id}.

          Type: string

          Location: query

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

  • run.projects.locations.services.getIamPolicy

      Parameter Order: resource

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

      Parameters:

        options.requestedPolicyVersion

          Type: integer

          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).

          Format: int32

        resource

          Required: Yes

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

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

          Location: path

          Type: string

      Path: v2/{+resource}:getIamPolicy

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy

      HTTP Method: GET

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

  • run.projects.locations.services.setIamPolicy

      HTTP Method: POST

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy

      Parameters:

        resource

          Location: path

          Type: string

          Required: Yes

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

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

      Path: v2/{+resource}:setIamPolicy

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

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

      Parameter Order: resource

  • run.projects.locations.services.get

      Parameter Order: name

      Description: Gets information about a Service.

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      HTTP Method: GET

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

      Parameters:

        name

          Location: path

          Description: Required. The full name of the Service. Format: projects/{projectnumber}/locations/{location}/services/{service}

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

          Type: string

          Required: Yes

      Path: v2/{+name}

  • run.projects.locations.services.list

      Description: List Services.

      Parameter Order: parent

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/services

      Path: v2/{+parent}/services

      HTTP Method: GET

      Parameters:

        pageToken

          Description: A page token received from a previous call to ListServices. All other parameters must match.

          Location: query

          Type: string

        showDeleted

          Description: If true, returns deleted (but unexpired) resources along with active ones.

          Type: boolean

          Location: query

        parent

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

          Location: path

          Required: Yes

          Description: Required. The location and project to list resources on. Format: projects/{projectnumber}/locations/{location}

          Type: string

        pageSize

          Type: integer

          Description: Maximum number of Services to return in this call.

          Format: int32

          Location: query

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