Skip to content

Commit 69fe169

Browse files
docs: Minor formatting (#433)
* 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>
1 parent 09390ef commit 69fe169

File tree

16 files changed

+39
-14
lines changed

16 files changed

+39
-14
lines changed

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v1/services/cloud_build/async_client.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -558,6 +558,7 @@ async def list_builds(
558558
metadata: Sequence[Tuple[str, str]] = (),
559559
) -> pagers.ListBuildsAsyncPager:
560560
r"""Lists previously requested builds.
561+
561562
Previously requested builds may still be in-progress, or
562563
may have finished successfully or unsuccessfully.
563564
@@ -612,6 +613,7 @@ async def sample_list_builds():
612613
Returns:
613614
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsAsyncPager:
614615
Response including listed builds.
616+
615617
Iterating over this object will yield
616618
results and resolve additional pages
617619
automatically.
@@ -1010,6 +1012,7 @@ async def approve_build(
10101012
metadata: Sequence[Tuple[str, str]] = (),
10111013
) -> operation_async.AsyncOperation:
10121014
r"""Approves or rejects a pending build.
1015+
10131016
If approved, the returned LRO will be analogous to the
10141017
LRO returned from a CreateBuild call.
10151018

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v1/services/cloud_build/client.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -964,6 +964,7 @@ def list_builds(
964964
metadata: Sequence[Tuple[str, str]] = (),
965965
) -> pagers.ListBuildsPager:
966966
r"""Lists previously requested builds.
967+
967968
Previously requested builds may still be in-progress, or
968969
may have finished successfully or unsuccessfully.
969970
@@ -1018,6 +1019,7 @@ def sample_list_builds():
10181019
Returns:
10191020
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsPager:
10201021
Response including listed builds.
1022+
10211023
Iterating over this object will yield
10221024
results and resolve additional pages
10231025
automatically.
@@ -1418,6 +1420,7 @@ def approve_build(
14181420
metadata: Sequence[Tuple[str, str]] = (),
14191421
) -> operation.Operation:
14201422
r"""Approves or rejects a pending build.
1423+
14211424
If approved, the returned LRO will be analogous to the
14221425
LRO returned from a CreateBuild call.
14231426

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v1/services/cloud_build/transports/grpc.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,7 @@ def list_builds(
319319
r"""Return a callable for the list builds method over gRPC.
320320
321321
Lists previously requested builds.
322+
322323
Previously requested builds may still be in-progress, or
323324
may have finished successfully or unsuccessfully.
324325
@@ -428,6 +429,7 @@ def approve_build(
428429
r"""Return a callable for the approve build method over gRPC.
429430
430431
Approves or rejects a pending build.
432+
431433
If approved, the returned LRO will be analogous to the
432434
LRO returned from a CreateBuild call.
433435

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v1/services/cloud_build/transports/grpc_asyncio.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,7 @@ def list_builds(
328328
r"""Return a callable for the list builds method over gRPC.
329329
330330
Lists previously requested builds.
331+
331332
Previously requested builds may still be in-progress, or
332333
may have finished successfully or unsuccessfully.
333334
@@ -439,6 +440,7 @@ def approve_build(
439440
r"""Return a callable for the approve build method over gRPC.
440441
441442
Approves or rejects a pending build.
443+
442444
If approved, the returned LRO will be analogous to the
443445
LRO returned from a CreateBuild call.
444446

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v1/services/cloud_build/transports/rest.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@
4141

4242

4343
from google.cloud.devtools.cloudbuild_v1.types import cloudbuild
44-
from google.longrunning import operations_pb2 # type: ignore
4544
from google.protobuf import empty_pb2 # type: ignore
45+
from google.longrunning import operations_pb2 # type: ignore
4646

4747
from .base import CloudBuildTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO
4848

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v1/types/cloudbuild.py

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,13 +255,15 @@ class RepoSource(proto.Message):
255255
Name of the Cloud Source Repository.
256256
branch_name (str):
257257
Regex matching branches to build.
258+
258259
The syntax of the regular expressions accepted
259260
is the syntax accepted by RE2 and described at
260261
https://github.com/google/re2/wiki/Syntax
261262
262263
This field is a member of `oneof`_ ``revision``.
263264
tag_name (str):
264265
Regex matching tags to build.
266+
265267
The syntax of the regular expressions accepted
266268
is the syntax accepted by RE2 and described at
267269
https://github.com/google/re2/wiki/Syntax
@@ -607,6 +609,7 @@ class BuildStep(proto.Message):
607609
be specified in the build's ``Secret``.
608610
volumes (MutableSequence[google.cloud.devtools.cloudbuild_v1.types.Volume]):
609611
List of volumes to mount into the build step.
612+
610613
Each volume is created as an empty volume prior
611614
to execution of the build step. Upon completion
612615
of the build, volumes and their contents are
@@ -649,6 +652,7 @@ class BuildStep(proto.Message):
649652
take precedence.
650653
script (str):
651654
A shell script to be executed in the step.
655+
652656
When script is provided, the user cannot specify
653657
the entrypoint or args.
654658
automap_substitutions (bool):
@@ -748,12 +752,14 @@ class Volume(proto.Message):
748752
Attributes:
749753
name (str):
750754
Name of the volume to mount.
755+
751756
Volume names must be unique per build step and
752757
must be valid names for Docker volumes. Each
753758
named volume must be used by at least two build
754759
steps.
755760
path (str):
756761
Path at which to mount the volume.
762+
757763
Paths must be absolute and cannot conflict with
758764
other volume paths on the same build step or
759765
with certain reserved volume paths.
@@ -1305,6 +1311,7 @@ class Artifacts(proto.Message):
13051311
13061312
The images will be pushed using the builder
13071313
service account's credentials.
1314+
13081315
The digests of the pushed images will be stored
13091316
in the Build resource's results field.
13101317
@@ -1314,6 +1321,7 @@ class Artifacts(proto.Message):
13141321
A list of objects to be uploaded to Cloud
13151322
Storage upon successful completion of all build
13161323
steps.
1324+
13171325
Files in the workspace matching specified paths
13181326
globs will be uploaded to the specified Cloud
13191327
Storage location using the builder service
@@ -1329,6 +1337,7 @@ class Artifacts(proto.Message):
13291337
A list of Maven artifacts to be uploaded to
13301338
Artifact Registry upon successful completion of
13311339
all build steps.
1340+
13321341
Artifacts in the workspace matching specified
13331342
paths globs will be uploaded to the specified
13341343
Artifact Registry repository using the builder
@@ -1340,14 +1349,17 @@ class Artifacts(proto.Message):
13401349
A list of Python packages to be uploaded to
13411350
Artifact Registry upon successful completion of
13421351
all build steps.
1352+
13431353
The build service account credentials will be
13441354
used to perform the upload.
1355+
13451356
If any objects fail to be pushed, the build is
13461357
marked FAILURE.
13471358
npm_packages (MutableSequence[google.cloud.devtools.cloudbuild_v1.types.Artifacts.NpmPackage]):
13481359
A list of npm packages to be uploaded to
13491360
Artifact Registry upon successful completion of
13501361
all build steps.
1362+
13511363
Npm packages in the specified paths will be
13521364
uploaded to the specified Artifact Registry
13531365
repository using the builder service account's
@@ -1399,6 +1411,7 @@ class MavenArtifact(proto.Message):
13991411
repository (str):
14001412
Artifact Registry repository, in the form
14011413
"https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY"
1414+
14021415
Artifact in the workspace specified by path will
14031416
be uploaded to Artifact Registry with this
14041417
location as a prefix.
@@ -1451,6 +1464,7 @@ class PythonPackage(proto.Message):
14511464
repository (str):
14521465
Artifact Registry repository, in the form
14531466
"https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY"
1467+
14541468
Files in the workspace matching any path pattern
14551469
will be uploaded to Artifact Registry with this
14561470
location as a prefix.
@@ -1477,6 +1491,7 @@ class NpmPackage(proto.Message):
14771491
repository (str):
14781492
Artifact Registry repository, in the form
14791493
"https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY"
1494+
14801495
Npm package in the workspace specified by path
14811496
will be zipped and uploaded to Artifact Registry
14821497
with this location as a prefix.
@@ -2754,6 +2769,7 @@ class PullRequestFilter(proto.Message):
27542769
Attributes:
27552770
branch (str):
27562771
Regex of branches to match.
2772+
27572773
The syntax of the regular expressions accepted
27582774
is the syntax accepted by RE2 and described at
27592775
https://github.com/google/re2/wiki/Syntax
@@ -2818,13 +2834,15 @@ class PushFilter(proto.Message):
28182834
Attributes:
28192835
branch (str):
28202836
Regexes matching branches to build.
2837+
28212838
The syntax of the regular expressions accepted
28222839
is the syntax accepted by RE2 and described at
28232840
https://github.com/google/re2/wiki/Syntax
28242841
28252842
This field is a member of `oneof`_ ``git_ref``.
28262843
tag (str):
28272844
Regexes matching tags to build.
2845+
28282846
The syntax of the regular expressions accepted
28292847
is the syntax accepted by RE2 and described at
28302848
https://github.com/google/re2/wiki/Syntax
@@ -3066,6 +3084,7 @@ class BuildOptions(proto.Message):
30663084
Option to specify whether or not to apply
30673085
bash style string operations to the
30683086
substitutions.
3087+
30693088
NOTE: this is always enabled for triggered
30703089
builds and cannot be overridden in the build
30713090
configuration file.
@@ -3093,6 +3112,7 @@ class BuildOptions(proto.Message):
30933112
in this build. If a variable is defined in both
30943113
globally and in a build step, the variable will
30953114
use the build step value.
3115+
30963116
The elements are of the form "KEY=VALUE" for the
30973117
environment variable "KEY" being given the value
30983118
"VALUE".
@@ -3547,9 +3567,8 @@ class WorkerPool(proto.Message):
35473567
Output only. A unique identifier for the ``WorkerPool``.
35483568
annotations (MutableMapping[str, str]):
35493569
User specified annotations. See
3550-
https://google.aip.dev/128#annotations
3551-
for more details such as format and size
3552-
limitations.
3570+
https://google.aip.dev/128#annotations for more
3571+
details such as format and size limitations.
35533572
create_time (google.protobuf.timestamp_pb2.Timestamp):
35543573
Output only. Time at which the request to create the
35553574
``WorkerPool`` was received.

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v2/services/repository_manager/async_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
from google.cloud.location import locations_pb2 # type: ignore
5151
from google.iam.v1 import iam_policy_pb2 # type: ignore
5252
from google.iam.v1 import policy_pb2 # type: ignore
53-
from google.longrunning import operations_pb2
53+
from google.longrunning import operations_pb2 # type: ignore
5454
from google.protobuf import empty_pb2 # type: ignore
5555
from google.protobuf import field_mask_pb2 # type: ignore
5656
from google.protobuf import timestamp_pb2 # type: ignore

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v2/services/repository_manager/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
from google.cloud.location import locations_pb2 # type: ignore
5555
from google.iam.v1 import iam_policy_pb2 # type: ignore
5656
from google.iam.v1 import policy_pb2 # type: ignore
57-
from google.longrunning import operations_pb2
57+
from google.longrunning import operations_pb2 # type: ignore
5858
from google.protobuf import empty_pb2 # type: ignore
5959
from google.protobuf import field_mask_pb2 # type: ignore
6060
from google.protobuf import timestamp_pb2 # type: ignore

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v2/services/repository_manager/transports/base.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
from google.cloud.location import locations_pb2 # type: ignore
3232
from google.iam.v1 import iam_policy_pb2 # type: ignore
3333
from google.iam.v1 import policy_pb2 # type: ignore
34-
from google.longrunning import operations_pb2
3534
from google.longrunning import operations_pb2 # type: ignore
3635

3736
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(

packages/google-cloud-build/google/cloud/devtools/cloudbuild_v2/services/repository_manager/transports/grpc.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@
2929
from google.cloud.location import locations_pb2 # type: ignore
3030
from google.iam.v1 import iam_policy_pb2 # type: ignore
3131
from google.iam.v1 import policy_pb2 # type: ignore
32-
from google.longrunning import operations_pb2
3332
from google.longrunning import operations_pb2 # type: ignore
3433
from .base import RepositoryManagerTransport, DEFAULT_CLIENT_INFO
3534

0 commit comments

Comments
 (0)