google_api_cloud_build

v0.7.0

google_api_cloud_build v0.7.0 GoogleApi.CloudBuild.V1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

cloudbuild_projects_builds_cancel(connection, project_id, id, optional_params \\ [], opts \\ [])

Cancels a build in progress.

cloudbuild_projects_builds_create(connection, project_id, optional_params \\ [], opts \\ [])

Starts a build with the specified configuration.

cloudbuild_projects_builds_get(connection, project_id, id, optional_params \\ [], opts \\ [])

Returns information about a previously requested build.

cloudbuild_projects_builds_list(connection, project_id, optional_params \\ [], opts \\ [])

Lists previously requested builds.

cloudbuild_projects_builds_retry(connection, project_id, id, optional_params \\ [], opts \\ [])

Creates a new build based on the specified build.

cloudbuild_projects_triggers_create(connection, project_id, optional_params \\ [], opts \\ [])

Creates a new BuildTrigger.

cloudbuild_projects_triggers_delete(connection, project_id, trigger_id, optional_params \\ [], opts \\ [])

Deletes a BuildTrigger by its project ID and trigger ID.

cloudbuild_projects_triggers_get(connection, project_id, trigger_id, optional_params \\ [], opts \\ [])

Returns information about a BuildTrigger.

cloudbuild_projects_triggers_list(connection, project_id, optional_params \\ [], opts \\ [])

Lists existing BuildTriggers.

cloudbuild_projects_triggers_patch(connection, project_id, trigger_id, optional_params \\ [], opts \\ [])

Updates a BuildTrigger by its project ID and trigger ID.

cloudbuild_projects_triggers_run(connection, project_id, trigger_id, optional_params \\ [], opts \\ [])

Runs a BuildTrigger at a particular source revision.

Link to this section Functions

Link to this function

cloudbuild_projects_builds_cancel(connection, project_id, id, optional_params \\ [], opts \\ []) View Source

Cancels a build in progress.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project.
  • id (String.t): ID of the build.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudBuild.V1.Model.CancelBuildRequest.t):

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.Build{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_builds_create(connection, project_id, optional_params \\ [], opts \\ []) View Source

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudBuild.V1.Model.Build.t):

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_builds_get(connection, project_id, id, optional_params \\ [], opts \\ []) View Source

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project.
  • id (String.t): ID of the build.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.Build{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_builds_list(connection, project_id, optional_params \\ [], opts \\ []) View Source

Lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :filter (String.t): The raw filter text to constrain the results.
    • :pageSize (integer()): Number of results to return in the list.
    • :pageToken (String.t): Token to provide to skip to a particular spot in the list.

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.ListBuildsResponse{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_builds_retry(connection, project_id, id, optional_params \\ [], opts \\ []) View Source

Creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

  • Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

  • If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
  • If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

  • If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
  • If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project.
  • id (String.t): Build ID of the original build.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudBuild.V1.Model.RetryBuildRequest.t):

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_triggers_create(connection, project_id, optional_params \\ [], opts \\ []) View Source

Creates a new BuildTrigger.

This API is experimental.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project for which to configure automatic builds.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudBuild.V1.Model.BuildTrigger.t):

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.BuildTrigger{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_triggers_delete(connection, project_id, trigger_id, optional_params \\ [], opts \\ []) View Source

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project that owns the trigger.
  • trigger_id (String.t): ID of the BuildTrigger to delete.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

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

Link to this function

cloudbuild_projects_triggers_get(connection, project_id, trigger_id, optional_params \\ [], opts \\ []) View Source

Returns information about a BuildTrigger.

This API is experimental.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project that owns the trigger.
  • trigger_id (String.t): ID of the BuildTrigger to get.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.BuildTrigger{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_triggers_list(connection, project_id, optional_params \\ [], opts \\ []) View Source

Lists existing BuildTriggers.

This API is experimental.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project for which to list BuildTriggers.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (integer()): Number of results to return in the list.
    • :pageToken (String.t): Token to provide to skip to a particular spot in the list.

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.ListBuildTriggersResponse{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_triggers_patch(connection, project_id, trigger_id, optional_params \\ [], opts \\ []) View Source

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project that owns the trigger.
  • trigger_id (String.t): ID of the BuildTrigger to update.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudBuild.V1.Model.BuildTrigger.t):

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.BuildTrigger{}} on success {:error, info} on failure

Link to this function

cloudbuild_projects_triggers_run(connection, project_id, trigger_id, optional_params \\ [], opts \\ []) View Source

Runs a BuildTrigger at a particular source revision.

Parameters

  • connection (GoogleApi.CloudBuild.V1.Connection): Connection to server
  • project_id (String.t): ID of the project.
  • trigger_id (String.t): ID of the trigger.

  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudBuild.V1.Model.RepoSource.t):

Returns

{:ok, %GoogleApi.CloudBuild.V1.Model.Operation{}} on success {:error, info} on failure