Cloud Run Admin API . projects . locations . builds

Instance Methods

close()

Close httplib2 connections.

submit(parent, body=None, x__xgafv=None)

Submits a build in a given project.

Method Details

close()
Close httplib2 connections.
submit(parent, body=None, x__xgafv=None)
Submits a build in a given project.

Args:
  parent: string, Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used. Format: `projects/{project}/locations/{location}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for submitting a Build.
  "buildpackBuild": { # Build the source using Buildpacks. # Build the source using Buildpacks.
    "baseImage": "A String", # Optional. The base image used to opt into automatic base image updates.
    "cacheImageUri": "A String", # Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching. This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.
    "enableAutomaticUpdates": True or False, # Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time.
    "environmentVariables": { # Optional. User-provided build-time environment variables.
      "a_key": "A String",
    },
    "functionTarget": "A String", # Optional. Name of the function target if the source is a function source. Required for function builds.
    "projectDescriptor": "A String", # Optional. project_descriptor stores the path to the project descriptor file. When empty, it means that there is no project descriptor file in the source.
    "runtime": "A String", # The runtime name, e.g. 'go113'. Leave blank for generic builds.
  },
  "dockerBuild": { # Build the source using Docker. This means the source has a Dockerfile. # Build the source using Docker. This means the source has a Dockerfile.
  },
  "imageUri": "A String", # Required. Artifact Registry URI to store the built image.
  "serviceAccount": "A String", # Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.
  "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # Required. Source for the build.
    "bucket": "A String", # Required. Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
    "generation": "A String", # Optional. Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
    "object": "A String", # Required. Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
  },
  "tags": [ # Optional. Additional tags to annotate the build.
    "A String",
  ],
  "workerPool": "A String", # Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where `{project}` and `{region}` are the project id and region respectively where the worker pool is defined and `{workerPool}` is the short name of the worker pool.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for submitting a Build.
  "baseImageUri": "A String", # URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates.
  "baseImageWarning": "A String", # Warning message for the base image.
  "buildOperation": { # This resource represents a long-running operation that is the result of a network API call. # Cloud Build operation to be polled via CloudBuild API.
    "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    },
    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
    "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  },
}