GoogleApi.Transcoder.V1.Api.Projects (google_api_transcoder v0.4.2)

@spec transcoder_projects_locations_job_templates_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Transcoder.V1.Model.JobTemplate.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a job template in the specified region.

Parameters

connection (type: GoogleApi.Transcoder.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent location to create this job template. Format: projects/{project}/locations/{location}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :jobTemplateId (type: String.t) - 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*.
- :body (type: GoogleApi.Transcoder.V1.Model.JobTemplate.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Transcoder.V1.Model.JobTemplate{}} on success
{:error, info} on failure

transcoder_projects_locations_job_templates_delete(connection, name, optional_params \\ [], opts \\ [])

@spec transcoder_projects_locations_job_templates_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Transcoder.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a job template.

Parameters

connection (type: GoogleApi.Transcoder.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the job template to delete. projects/{project}/locations/{location}/jobTemplates/{job_template}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :allowMissing (type: boolean()) - If set to true, and the job template is not found, the request will succeed but no action will be taken on the server.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Transcoder.V1.Model.Empty{}} on success
{:error, info} on failure

transcoder_projects_locations_job_templates_get(connection, name, optional_params \\ [], opts \\ [])

@spec transcoder_projects_locations_job_templates_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Transcoder.V1.Model.JobTemplate.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the job template data.

Parameters

connection (type: GoogleApi.Transcoder.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the job template to retrieve. Format: projects/{project}/locations/{location}/jobTemplates/{job_template}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Transcoder.V1.Model.JobTemplate{}} on success
{:error, info} on failure

transcoder_projects_locations_job_templates_list(connection, parent, optional_params \\ [], opts \\ [])

@spec transcoder_projects_locations_job_templates_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Transcoder.V1.Model.ListJobTemplatesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists job templates in the specified region.

Parameters

connection (type: GoogleApi.Transcoder.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent location from which to retrieve the collection of job templates. Format: projects/{project}/locations/{location}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :filter (type: String.t) - The filter expression, following the syntax outlined in https://google.aip.dev/160.
- :orderBy (type: String.t) - One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
- :pageSize (type: integer()) - The maximum number of items to return.
- :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Transcoder.V1.Model.ListJobTemplatesResponse{}} on success
{:error, info} on failure

transcoder_projects_locations_jobs_create(connection, parent, optional_params \\ [], opts \\ [])

@spec transcoder_projects_locations_jobs_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Transcoder.V1.Model.Job.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a job in the specified region.

Parameters

connection (type: GoogleApi.Transcoder.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent location to create and process this job. Format: projects/{project}/locations/{location}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Transcoder.V1.Model.Job.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Transcoder.V1.Model.Job{}} on success
{:error, info} on failure

transcoder_projects_locations_jobs_delete(connection, name, optional_params \\ [], opts \\ [])

@spec transcoder_projects_locations_jobs_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Transcoder.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a job.

Parameters

connection (type: GoogleApi.Transcoder.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the job to delete. Format: projects/{project}/locations/{location}/jobs/{job}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :allowMissing (type: boolean()) - If set to true, and the job is not found, the request will succeed but no action will be taken on the server.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Transcoder.V1.Model.Empty{}} on success
{:error, info} on failure

transcoder_projects_locations_jobs_get(connection, name, optional_params \\ [], opts \\ [])

@spec transcoder_projects_locations_jobs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Transcoder.V1.Model.Job.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the job data.

Parameters

connection (type: GoogleApi.Transcoder.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the job to retrieve. Format: projects/{project}/locations/{location}/jobs/{job}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Transcoder.V1.Model.Job{}} on success
{:error, info} on failure

transcoder_projects_locations_jobs_list(connection, parent, optional_params \\ [], opts \\ [])

@spec transcoder_projects_locations_jobs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Transcoder.V1.Model.ListJobsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists jobs in the specified region.

Parameters

connection (type: GoogleApi.Transcoder.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. Format: projects/{project}/locations/{location}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :filter (type: String.t) - The filter expression, following the syntax outlined in https://google.aip.dev/160.
- :orderBy (type: String.t) - One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
- :pageSize (type: integer()) - The maximum number of items to return.
- :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Transcoder.V1.Model.ListJobsResponse{}} on success
{:error, info} on failure