Skip to content

Commit

Permalink
docs: Minor formatting (#433)
Browse files Browse the repository at this point in the history
* docs: Minor formatting
chore: Update gapic-generator-python to v1.11.5
build: Update rules_python to 0.24.0

PiperOrigin-RevId: 563436317

Source-Link: googleapis/googleapis@42fd37b

Source-Link: googleapis/googleapis-gen@280264c
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Sep 13, 2023
1 parent 09390ef commit 69fe169
Show file tree
Hide file tree
Showing 16 changed files with 39 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,7 @@ async def list_builds(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListBuildsAsyncPager:
r"""Lists previously requested builds.
Previously requested builds may still be in-progress, or
may have finished successfully or unsuccessfully.
Expand Down Expand Up @@ -612,6 +613,7 @@ async def sample_list_builds():
Returns:
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsAsyncPager:
Response including listed builds.
Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down Expand Up @@ -1010,6 +1012,7 @@ async def approve_build(
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Approves or rejects a pending build.
If approved, the returned LRO will be analogous to the
LRO returned from a CreateBuild call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -964,6 +964,7 @@ def list_builds(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListBuildsPager:
r"""Lists previously requested builds.
Previously requested builds may still be in-progress, or
may have finished successfully or unsuccessfully.
Expand Down Expand Up @@ -1018,6 +1019,7 @@ def sample_list_builds():
Returns:
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsPager:
Response including listed builds.
Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down Expand Up @@ -1418,6 +1420,7 @@ def approve_build(
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Approves or rejects a pending build.
If approved, the returned LRO will be analogous to the
LRO returned from a CreateBuild call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,7 @@ def list_builds(
r"""Return a callable for the list builds method over gRPC.
Lists previously requested builds.
Previously requested builds may still be in-progress, or
may have finished successfully or unsuccessfully.
Expand Down Expand Up @@ -428,6 +429,7 @@ def approve_build(
r"""Return a callable for the approve build method over gRPC.
Approves or rejects a pending build.
If approved, the returned LRO will be analogous to the
LRO returned from a CreateBuild call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@ def list_builds(
r"""Return a callable for the list builds method over gRPC.
Lists previously requested builds.
Previously requested builds may still be in-progress, or
may have finished successfully or unsuccessfully.
Expand Down Expand Up @@ -439,6 +440,7 @@ def approve_build(
r"""Return a callable for the approve build method over gRPC.
Approves or rejects a pending build.
If approved, the returned LRO will be analogous to the
LRO returned from a CreateBuild call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@


from google.cloud.devtools.cloudbuild_v1.types import cloudbuild
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from .base import CloudBuildTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,13 +255,15 @@ class RepoSource(proto.Message):
Name of the Cloud Source Repository.
branch_name (str):
Regex matching branches to build.
The syntax of the regular expressions accepted
is the syntax accepted by RE2 and described at
https://github.com/google/re2/wiki/Syntax
This field is a member of `oneof`_ ``revision``.
tag_name (str):
Regex matching tags to build.
The syntax of the regular expressions accepted
is the syntax accepted by RE2 and described at
https://github.com/google/re2/wiki/Syntax
Expand Down Expand Up @@ -607,6 +609,7 @@ class BuildStep(proto.Message):
be specified in the build's ``Secret``.
volumes (MutableSequence[google.cloud.devtools.cloudbuild_v1.types.Volume]):
List of volumes to mount into the build step.
Each volume is created as an empty volume prior
to execution of the build step. Upon completion
of the build, volumes and their contents are
Expand Down Expand Up @@ -649,6 +652,7 @@ class BuildStep(proto.Message):
take precedence.
script (str):
A shell script to be executed in the step.
When script is provided, the user cannot specify
the entrypoint or args.
automap_substitutions (bool):
Expand Down Expand Up @@ -748,12 +752,14 @@ class Volume(proto.Message):
Attributes:
name (str):
Name of the volume to mount.
Volume names must be unique per build step and
must be valid names for Docker volumes. Each
named volume must be used by at least two build
steps.
path (str):
Path at which to mount the volume.
Paths must be absolute and cannot conflict with
other volume paths on the same build step or
with certain reserved volume paths.
Expand Down Expand Up @@ -1305,6 +1311,7 @@ class Artifacts(proto.Message):
The images will be pushed using the builder
service account's credentials.
The digests of the pushed images will be stored
in the Build resource's results field.
Expand All @@ -1314,6 +1321,7 @@ class Artifacts(proto.Message):
A list of objects to be uploaded to Cloud
Storage upon successful completion of all build
steps.
Files in the workspace matching specified paths
globs will be uploaded to the specified Cloud
Storage location using the builder service
Expand All @@ -1329,6 +1337,7 @@ class Artifacts(proto.Message):
A list of Maven artifacts to be uploaded to
Artifact Registry upon successful completion of
all build steps.
Artifacts in the workspace matching specified
paths globs will be uploaded to the specified
Artifact Registry repository using the builder
Expand All @@ -1340,14 +1349,17 @@ class Artifacts(proto.Message):
A list of Python packages to be uploaded to
Artifact Registry upon successful completion of
all build steps.
The build service account credentials will be
used to perform the upload.
If any objects fail to be pushed, the build is
marked FAILURE.
npm_packages (MutableSequence[google.cloud.devtools.cloudbuild_v1.types.Artifacts.NpmPackage]):
A list of npm packages to be uploaded to
Artifact Registry upon successful completion of
all build steps.
Npm packages in the specified paths will be
uploaded to the specified Artifact Registry
repository using the builder service account's
Expand Down Expand Up @@ -1399,6 +1411,7 @@ class MavenArtifact(proto.Message):
repository (str):
Artifact Registry repository, in the form
"https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY"
Artifact in the workspace specified by path will
be uploaded to Artifact Registry with this
location as a prefix.
Expand Down Expand Up @@ -1451,6 +1464,7 @@ class PythonPackage(proto.Message):
repository (str):
Artifact Registry repository, in the form
"https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY"
Files in the workspace matching any path pattern
will be uploaded to Artifact Registry with this
location as a prefix.
Expand All @@ -1477,6 +1491,7 @@ class NpmPackage(proto.Message):
repository (str):
Artifact Registry repository, in the form
"https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY"
Npm package in the workspace specified by path
will be zipped and uploaded to Artifact Registry
with this location as a prefix.
Expand Down Expand Up @@ -2754,6 +2769,7 @@ class PullRequestFilter(proto.Message):
Attributes:
branch (str):
Regex of branches to match.
The syntax of the regular expressions accepted
is the syntax accepted by RE2 and described at
https://github.com/google/re2/wiki/Syntax
Expand Down Expand Up @@ -2818,13 +2834,15 @@ class PushFilter(proto.Message):
Attributes:
branch (str):
Regexes matching branches to build.
The syntax of the regular expressions accepted
is the syntax accepted by RE2 and described at
https://github.com/google/re2/wiki/Syntax
This field is a member of `oneof`_ ``git_ref``.
tag (str):
Regexes matching tags to build.
The syntax of the regular expressions accepted
is the syntax accepted by RE2 and described at
https://github.com/google/re2/wiki/Syntax
Expand Down Expand Up @@ -3066,6 +3084,7 @@ class BuildOptions(proto.Message):
Option to specify whether or not to apply
bash style string operations to the
substitutions.
NOTE: this is always enabled for triggered
builds and cannot be overridden in the build
configuration file.
Expand Down Expand Up @@ -3093,6 +3112,7 @@ class BuildOptions(proto.Message):
in this build. If a variable is defined in both
globally and in a build step, the variable will
use the build step value.
The elements are of the form "KEY=VALUE" for the
environment variable "KEY" being given the value
"VALUE".
Expand Down Expand Up @@ -3547,9 +3567,8 @@ class WorkerPool(proto.Message):
Output only. A unique identifier for the ``WorkerPool``.
annotations (MutableMapping[str, str]):
User specified annotations. See
https://google.aip.dev/128#annotations
for more details such as format and size
limitations.
https://google.aip.dev/128#annotations for more
details such as format and size limitations.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time at which the request to create the
``WorkerPool`` was received.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from .base import RepositoryManagerTransport, DEFAULT_CLIENT_INFO

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
from google.cloud.location import locations_pb2 # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from .base import RepositoryManagerTransport, DEFAULT_CLIENT_INFO
from .grpc import RepositoryManagerGrpcTransport
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.cloud.location import locations_pb2 # type: ignore
from google.longrunning import operations_pb2
from requests import __version__ as requests_version
import dataclasses
import re
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-build",
"version": "3.20.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-build",
"version": "3.20.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
from google.cloud.devtools.cloudbuild_v1.services.cloud_build import pagers
from google.cloud.devtools.cloudbuild_v1.services.cloud_build import transports
from google.cloud.devtools.cloudbuild_v1.types import cloudbuild
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import any_pb2 # type: ignore
from google.protobuf import duration_pb2 # type: ignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import options_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
Expand Down

0 comments on commit 69fe169

Please sign in to comment.