Transcoder API (transcoder:v1)

2021-12-14

8 new methods | New API

Additions

    Methods
  • transcoder.projects.locations.jobTemplates.delete

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}

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

      Parameters:

        allowMissing

          Location: query

          Type: boolean

          Description: If set to true, and the job template is not found, the request will succeed but no action will be taken on the server.

        name

          Location: path

          Type: string

          Required: Yes

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

          Description: Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}`

      HTTP Method: DELETE

      Description: Deletes a job template.

      Path: v1/{+name}

  • transcoder.projects.locations.jobTemplates.create

      Parameter Order: parent

      Description: Creates a job template in the specified region.

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

      Parameters:

        jobTemplateId

          Location: query

          Type: string

          Description: Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the regular expression `a-zA-Z*`.

        parent

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

          Location: path

          Required: Yes

          Type: string

          Description: Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}`

      Path: v1/{+parent}/jobTemplates

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/jobTemplates

      HTTP Method: POST

  • transcoder.projects.locations.jobTemplates.get

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

      HTTP Method: GET

      Parameters:

        name

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

          Location: path

          Description: Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`

          Type: string

          Required: Yes

      Parameter Order: name

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}

      Description: Returns the job template data.

  • transcoder.projects.locations.jobTemplates.list

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

      Parameter Order: parent

      Description: Lists job templates in the specified region.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/jobTemplates

      Path: v1/{+parent}/jobTemplates

      HTTP Method: GET

      Parameters:

        orderBy

          Location: query

          Description: One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

          Type: string

        pageToken

          Location: query

          Description: The `next_page_token` value returned from a previous List request, if any.

          Type: string

        filter

          Location: query

          Description: The filter expression, following the syntax outlined in https://google.aip.dev/160.

          Type: string

        parent

          Required: Yes

          Type: string

          Location: path

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

          Description: Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}`

        pageSize

          Format: int32

          Type: integer

          Location: query

          Description: The maximum number of items to return.

  • transcoder.projects.locations.jobs.delete

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

      HTTP Method: DELETE

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

      Description: Deletes a job.

      Path: v1/{+name}

      Parameter Order: name

      Parameters:

        allowMissing

          Type: boolean

          Location: query

          Description: If set to true, and the job is not found, the request will succeed but no action will be taken on the server.

        name

          Required: Yes

          Description: Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}`

          Location: path

          Type: string

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

  • transcoder.projects.locations.jobs.list

      Parameters:

        pageToken

          Description: The `next_page_token` value returned from a previous List request, if any.

          Type: string

          Location: query

        pageSize

          Type: integer

          Location: query

          Format: int32

          Description: The maximum number of items to return.

        parent

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

          Description: Required. Format: `projects/{project}/locations/{location}`

          Location: path

          Required: Yes

          Type: string

        filter

          Type: string

          Location: query

          Description: The filter expression, following the syntax outlined in https://google.aip.dev/160.

        orderBy

          Description: One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

          Location: query

          Type: string

      Description: Lists jobs in the specified region.

      Parameter Order: parent

      Path: v1/{+parent}/jobs

      HTTP Method: GET

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

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

  • transcoder.projects.locations.jobs.create

      Parameter Order: parent

      Path: v1/{+parent}/jobs

      HTTP Method: POST

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

      Parameters:

        parent

          Location: path

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

          Description: Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}`

          Type: string

          Required: Yes

      Description: Creates a job in the specified region.

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

  • transcoder.projects.locations.jobs.get

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

      Parameter Order: name

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

      Parameters:

        name

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

          Required: Yes

          Description: Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}`

          Location: path

          Type: string

      Description: Returns the job data.

      HTTP Method: GET

      Path: v1/{+name}