RepositoryManager¶
- class google.cloud.devtools.cloudbuild_v2.services.repository_manager.RepositoryManagerAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.devtools.cloudbuild_v2.services.repository_manager.transports.base.RepositoryManagerTransport, typing.Callable[[...], google.cloud.devtools.cloudbuild_v2.services.repository_manager.transports.base.RepositoryManagerTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
Manages connections to source code repositories.
Instantiates the repository manager async client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,RepositoryManagerTransport,Callable[..., RepositoryManagerTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the RepositoryManagerTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.
1. The
api_endpoint
property can be used to override the default endpoint provided by the client whentransport
is not explicitly provided. Only if this property is not set andtransport
was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the
client_cert_source
property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.3. The
universe_domain
property can be used to override the default “googleapis.com” universe. Note thatapi_endpoint
property still takes precedence; anduniverse_domain
is currently not supported for mTLS.client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- async batch_create_repositories(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.BatchCreateRepositoriesRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.cloud.devtools.cloudbuild_v2.types.repositories.CreateRepositoryRequest]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates multiple repositories inside a connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_batch_create_repositories(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) requests = cloudbuild_v2.CreateRepositoryRequest() requests.parent = "parent_value" requests.repository.remote_uri = "remote_uri_value" requests.repository_id = "repository_id_value" request = cloudbuild_v2.BatchCreateRepositoriesRequest( parent="parent_value", requests=requests, ) # Make the request operation = client.batch_create_repositories(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.BatchCreateRepositoriesRequest, dict]]) – The request object. Message for creating repositoritories in batch.
parent (
str
) –Required. The connection to contain all the repositories being created. Format: projects//locations//connections/* The parent field in the CreateRepositoryRequest messages must either be empty or match this field.
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.requests (
MutableSequence[google.cloud.devtools.cloudbuild_v2.types.CreateRepositoryRequest]
) –Required. The request messages specifying the repositories to create.
This corresponds to the
requests
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v2.types.BatchCreateRepositoriesResponse
Message for response of creating repositories in batch.- Return type
- async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
- Parameters
request (
CancelOperationRequest
) – The request object. Request message for CancelOperation method.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
None
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- static connection_path(project: str, location: str, connection: str) str ¶
Returns a fully-qualified connection string.
- async create_connection(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.CreateConnectionRequest, dict]] = None, *, parent: Optional[str] = None, connection: Optional[google.cloud.devtools.cloudbuild_v2.types.repositories.Connection] = None, connection_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates a Connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_create_connection(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.CreateConnectionRequest( parent="parent_value", connection_id="connection_id_value", ) # Make the request operation = client.create_connection(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.CreateConnectionRequest, dict]]) – The request object. Message for creating a Connection
parent (
str
) –Required. Project and location where the connection will be created. Format:
projects/*/locations/*
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.connection (
google.cloud.devtools.cloudbuild_v2.types.Connection
) – Required. The Connection to create. This corresponds to theconnection
field on therequest
instance; ifrequest
is provided, this should not be set.connection_id (
str
) –Required. The ID to use for the Connection, which will become the final component of the Connection’s resource name. Names must be unique per-project per-location. Allows alphanumeric characters and any of -._~%!$&’()*+,;=@.
This corresponds to the
connection_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.devtools.cloudbuild_v2.types.Connection
A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.
- The result type for the operation will be
- Return type
- async create_repository(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.CreateRepositoryRequest, dict]] = None, *, parent: Optional[str] = None, repository: Optional[google.cloud.devtools.cloudbuild_v2.types.repositories.Repository] = None, repository_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates a Repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_create_repository(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) repository = cloudbuild_v2.Repository() repository.remote_uri = "remote_uri_value" request = cloudbuild_v2.CreateRepositoryRequest( parent="parent_value", repository=repository, repository_id="repository_id_value", ) # Make the request operation = client.create_repository(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.CreateRepositoryRequest, dict]]) – The request object. Message for creating a Repository.
parent (
str
) –Required. The connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there.
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.repository (
google.cloud.devtools.cloudbuild_v2.types.Repository
) – Required. The repository to create. This corresponds to therepository
field on therequest
instance; ifrequest
is provided, this should not be set.repository_id (
str
) –Required. The ID to use for the repository, which will become the final component of the repository’s resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&’()*+,;=@.
This corresponds to the
repository_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v2.types.Repository
A repository associated to a parent connection.- Return type
- async delete_connection(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.DeleteConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Deletes a single connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_delete_connection(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.DeleteConnectionRequest( name="name_value", ) # Make the request operation = client.delete_connection(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.DeleteConnectionRequest, dict]]) – The request object. Message for deleting a Connection.
name (
str
) –Required. The name of the Connection to delete. Format:
projects/*/locations/*/connections/*
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
- The result type for the operation will be
- Return type
- async delete_repository(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.DeleteRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Deletes a single repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_delete_repository(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.DeleteRepositoryRequest( name="name_value", ) # Make the request operation = client.delete_repository(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.DeleteRepositoryRequest, dict]]) – The request object. Message for deleting a Repository.
name (
str
) –Required. The name of the Repository to delete. Format:
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
- The result type for the operation will be
- Return type
- async fetch_git_refs(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchGitRefsRequest, dict]] = None, *, repository: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.FetchGitRefsResponse [source]¶
Fetch the list of branches or tags for a given repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_fetch_git_refs(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.FetchGitRefsRequest( repository="repository_value", ) # Make the request response = await client.fetch_git_refs(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.FetchGitRefsRequest, dict]]) – The request object. Request for fetching git refs
repository (
str
) –Required. The resource name of the repository in the format
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
repository
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response for fetching git refs
- Return type
google.cloud.devtools.cloudbuild_v2.types.FetchGitRefsResponse
- async fetch_linkable_repositories(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchLinkableRepositoriesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.FetchLinkableRepositoriesAsyncPager [source]¶
FetchLinkableRepositories get repositories from SCM that are accessible and could be added to the connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_fetch_linkable_repositories(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.FetchLinkableRepositoriesRequest( connection="connection_value", ) # Make the request page_result = client.fetch_linkable_repositories(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesRequest, dict]]) – The request object. Request message for FetchLinkableRepositories.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response message for FetchLinkableRepositories. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
- async fetch_read_token(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchReadTokenRequest, dict]] = None, *, repository: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.FetchReadTokenResponse [source]¶
Fetches read token of a given repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_fetch_read_token(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.FetchReadTokenRequest( repository="repository_value", ) # Make the request response = await client.fetch_read_token(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.FetchReadTokenRequest, dict]]) – The request object. Message for fetching SCM read token.
repository (
str
) –Required. The resource name of the repository in the format
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
repository
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Message for responding to get read token.
- Return type
google.cloud.devtools.cloudbuild_v2.types.FetchReadTokenResponse
- async fetch_read_write_token(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchReadWriteTokenRequest, dict]] = None, *, repository: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.FetchReadWriteTokenResponse [source]¶
Fetches read/write token of a given repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_fetch_read_write_token(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.FetchReadWriteTokenRequest( repository="repository_value", ) # Make the request response = await client.fetch_read_write_token(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.FetchReadWriteTokenRequest, dict]]) – The request object. Message for fetching SCM read/write token.
repository (
str
) –Required. The resource name of the repository in the format
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
repository
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Message for responding to get read/write token.
- Return type
google.cloud.devtools.cloudbuild_v2.types.FetchReadWriteTokenResponse
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- async get_connection(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.GetConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.Connection [source]¶
Gets details of a single connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_get_connection(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.GetConnectionRequest( name="name_value", ) # Make the request response = await client.get_connection(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.GetConnectionRequest, dict]]) – The request object. Message for getting the details of a Connection.
name (
str
) –Required. The name of the Connection to retrieve. Format:
projects/*/locations/*/connections/*
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.
- Return type
- async get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Gets the IAM access control policy for a function.
Returns an empty policy if the function exists and does not have a policy set.
- Parameters
request (
GetIamPolicyRequest
) – The request object. Request message for GetIamPolicy method.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A
Policy
is a collection ofbindings
. Abinding
binds one or moremembers
to a singlerole
. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Arole
is a named list of permissions (defined by IAM or configured by users). Abinding
can optionally specify acondition
, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.JSON Example
{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] }
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
For a description of IAM and its features, see the IAM developer’s guide.
- Return type
Policy
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.
The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
- Parameters
client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.Operation [source]¶
Gets the latest state of a long-running operation.
- Parameters
request (
GetOperationRequest
) – The request object. Request message for GetOperation method.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An
Operation
object.- Return type
Operation
- async get_repository(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.GetRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.Repository [source]¶
Gets details of a single repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_get_repository(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.GetRepositoryRequest( name="name_value", ) # Make the request response = await client.get_repository(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.GetRepositoryRequest, dict]]) – The request object. Message for getting the details of a Repository.
name (
str
) –Required. The name of the Repository to retrieve. Format:
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A repository associated to a parent connection.
- Return type
- classmethod get_transport_class(label: Optional[str] = None) Type[google.cloud.devtools.cloudbuild_v2.services.repository_manager.transports.base.RepositoryManagerTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- async list_connections(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.ListConnectionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListConnectionsAsyncPager [source]¶
Lists Connections in a given project and location.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_list_connections(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.ListConnectionsRequest( parent="parent_value", ) # Make the request page_result = client.list_connections(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.ListConnectionsRequest, dict]]) – The request object. Message for requesting list of Connections.
parent (
str
) –Required. The parent, which owns this collection of Connections. Format:
projects/*/locations/*
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Message for response to listing Connections. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListConnectionsAsyncPager
- async list_repositories(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.ListRepositoriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListRepositoriesAsyncPager [source]¶
Lists Repositories in a given connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_list_repositories(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.ListRepositoriesRequest( parent="parent_value", ) # Make the request page_result = client.list_repositories(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesRequest, dict]]) – The request object. Message for requesting list of Repositories.
parent (
str
) –Required. The parent, which owns this collection of Repositories. Format:
projects/*/locations/*/connections/*
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Message for response to listing Repositories. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListRepositoriesAsyncPager
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- static parse_connection_path(path: str) Dict[str, str] ¶
Parses a connection path into its component segments.
- static parse_repository_path(path: str) Dict[str, str] ¶
Parses a repository path into its component segments.
- static parse_secret_version_path(path: str) Dict[str, str] ¶
Parses a secret_version path into its component segments.
- static parse_service_path(path: str) Dict[str, str] ¶
Parses a service path into its component segments.
- static repository_path(project: str, location: str, connection: str, repository: str) str ¶
Returns a fully-qualified repository string.
- static secret_version_path(project: str, secret: str, version: str) str ¶
Returns a fully-qualified secret_version string.
- static service_path(project: str, location: str, namespace: str, service: str) str ¶
Returns a fully-qualified service string.
- async set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Sets the IAM access control policy on the specified function.
Replaces any existing policy.
- Parameters
request (
SetIamPolicyRequest
) – The request object. Request message for SetIamPolicy method.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A
Policy
is a collection ofbindings
. Abinding
binds one or moremembers
to a singlerole
. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Arole
is a named list of permissions (defined by IAM or configured by users). Abinding
can optionally specify acondition
, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.JSON Example
{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] }
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
For a description of IAM and its features, see the IAM developer’s guide.
- Return type
Policy
- async test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
- Tests the specified IAM permissions against the IAM access control
policy for a function.
If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
- Parameters
request (
TestIamPermissionsRequest
) – The request object. Request message for TestIamPermissions method.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response message for
TestIamPermissions
method.- Return type
TestIamPermissionsResponse
- property transport: google.cloud.devtools.cloudbuild_v2.services.repository_manager.transports.base.RepositoryManagerTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
RepositoryManagerTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
- The universe domain used
by the client instance.
- Return type
- async update_connection(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.UpdateConnectionRequest, dict]] = None, *, connection: Optional[google.cloud.devtools.cloudbuild_v2.types.repositories.Connection] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Updates a single connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 async def sample_update_connection(): # Create a client client = cloudbuild_v2.RepositoryManagerAsyncClient() # Initialize request argument(s) request = cloudbuild_v2.UpdateConnectionRequest( ) # Make the request operation = client.update_connection(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.devtools.cloudbuild_v2.types.UpdateConnectionRequest, dict]]) – The request object. Message for updating a Connection.
connection (
google.cloud.devtools.cloudbuild_v2.types.Connection
) – Required. The Connection to update. This corresponds to theconnection
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) – The list of fields to be updated. This corresponds to theupdate_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.devtools.cloudbuild_v2.types.Connection
A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.
- The result type for the operation will be
- Return type
- class google.cloud.devtools.cloudbuild_v2.services.repository_manager.RepositoryManagerClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.devtools.cloudbuild_v2.services.repository_manager.transports.base.RepositoryManagerTransport, typing.Callable[[...], google.cloud.devtools.cloudbuild_v2.services.repository_manager.transports.base.RepositoryManagerTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
Manages connections to source code repositories.
Instantiates the repository manager client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,RepositoryManagerTransport,Callable[..., RepositoryManagerTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the RepositoryManagerTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.
1. The
api_endpoint
property can be used to override the default endpoint provided by the client whentransport
is not explicitly provided. Only if this property is not set andtransport
was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the
client_cert_source
property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.3. The
universe_domain
property can be used to override the default “googleapis.com” universe. Note that theapi_endpoint
property still takes precedence; anduniverse_domain
is currently not supported for mTLS.client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- batch_create_repositories(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.BatchCreateRepositoriesRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.cloud.devtools.cloudbuild_v2.types.repositories.CreateRepositoryRequest]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates multiple repositories inside a connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_batch_create_repositories(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) requests = cloudbuild_v2.CreateRepositoryRequest() requests.parent = "parent_value" requests.repository.remote_uri = "remote_uri_value" requests.repository_id = "repository_id_value" request = cloudbuild_v2.BatchCreateRepositoriesRequest( parent="parent_value", requests=requests, ) # Make the request operation = client.batch_create_repositories(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.BatchCreateRepositoriesRequest, dict]) – The request object. Message for creating repositoritories in batch.
parent (str) –
Required. The connection to contain all the repositories being created. Format: projects//locations//connections/* The parent field in the CreateRepositoryRequest messages must either be empty or match this field.
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.requests (MutableSequence[google.cloud.devtools.cloudbuild_v2.types.CreateRepositoryRequest]) –
Required. The request messages specifying the repositories to create.
This corresponds to the
requests
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v2.types.BatchCreateRepositoriesResponse
Message for response of creating repositories in batch.- Return type
- cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
- Parameters
request (
CancelOperationRequest
) – The request object. Request message for CancelOperation method.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
None
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- static connection_path(project: str, location: str, connection: str) str [source]¶
Returns a fully-qualified connection string.
- create_connection(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.CreateConnectionRequest, dict]] = None, *, parent: Optional[str] = None, connection: Optional[google.cloud.devtools.cloudbuild_v2.types.repositories.Connection] = None, connection_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates a Connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_create_connection(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.CreateConnectionRequest( parent="parent_value", connection_id="connection_id_value", ) # Make the request operation = client.create_connection(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.CreateConnectionRequest, dict]) – The request object. Message for creating a Connection
parent (str) –
Required. Project and location where the connection will be created. Format:
projects/*/locations/*
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.connection (google.cloud.devtools.cloudbuild_v2.types.Connection) – Required. The Connection to create. This corresponds to the
connection
field on therequest
instance; ifrequest
is provided, this should not be set.connection_id (str) –
Required. The ID to use for the Connection, which will become the final component of the Connection’s resource name. Names must be unique per-project per-location. Allows alphanumeric characters and any of -._~%!$&’()*+,;=@.
This corresponds to the
connection_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.devtools.cloudbuild_v2.types.Connection
A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.
- The result type for the operation will be
- Return type
- create_repository(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.CreateRepositoryRequest, dict]] = None, *, parent: Optional[str] = None, repository: Optional[google.cloud.devtools.cloudbuild_v2.types.repositories.Repository] = None, repository_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates a Repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_create_repository(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) repository = cloudbuild_v2.Repository() repository.remote_uri = "remote_uri_value" request = cloudbuild_v2.CreateRepositoryRequest( parent="parent_value", repository=repository, repository_id="repository_id_value", ) # Make the request operation = client.create_repository(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.CreateRepositoryRequest, dict]) – The request object. Message for creating a Repository.
parent (str) –
Required. The connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there.
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.repository (google.cloud.devtools.cloudbuild_v2.types.Repository) – Required. The repository to create. This corresponds to the
repository
field on therequest
instance; ifrequest
is provided, this should not be set.repository_id (str) –
Required. The ID to use for the repository, which will become the final component of the repository’s resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&’()*+,;=@.
This corresponds to the
repository_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v2.types.Repository
A repository associated to a parent connection.- Return type
- delete_connection(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.DeleteConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Deletes a single connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_delete_connection(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.DeleteConnectionRequest( name="name_value", ) # Make the request operation = client.delete_connection(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.DeleteConnectionRequest, dict]) – The request object. Message for deleting a Connection.
name (str) –
Required. The name of the Connection to delete. Format:
projects/*/locations/*/connections/*
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
- The result type for the operation will be
- Return type
- delete_repository(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.DeleteRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Deletes a single repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_delete_repository(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.DeleteRepositoryRequest( name="name_value", ) # Make the request operation = client.delete_repository(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.DeleteRepositoryRequest, dict]) – The request object. Message for deleting a Repository.
name (str) –
Required. The name of the Repository to delete. Format:
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
- The result type for the operation will be
- Return type
- fetch_git_refs(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchGitRefsRequest, dict]] = None, *, repository: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.FetchGitRefsResponse [source]¶
Fetch the list of branches or tags for a given repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_fetch_git_refs(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.FetchGitRefsRequest( repository="repository_value", ) # Make the request response = client.fetch_git_refs(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.FetchGitRefsRequest, dict]) – The request object. Request for fetching git refs
repository (str) –
Required. The resource name of the repository in the format
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
repository
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response for fetching git refs
- Return type
google.cloud.devtools.cloudbuild_v2.types.FetchGitRefsResponse
- fetch_linkable_repositories(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchLinkableRepositoriesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.FetchLinkableRepositoriesPager [source]¶
FetchLinkableRepositories get repositories from SCM that are accessible and could be added to the connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_fetch_linkable_repositories(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.FetchLinkableRepositoriesRequest( connection="connection_value", ) # Make the request page_result = client.fetch_linkable_repositories(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesRequest, dict]) – The request object. Request message for FetchLinkableRepositories.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response message for FetchLinkableRepositories. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
- fetch_read_token(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchReadTokenRequest, dict]] = None, *, repository: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.FetchReadTokenResponse [source]¶
Fetches read token of a given repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_fetch_read_token(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.FetchReadTokenRequest( repository="repository_value", ) # Make the request response = client.fetch_read_token(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.FetchReadTokenRequest, dict]) – The request object. Message for fetching SCM read token.
repository (str) –
Required. The resource name of the repository in the format
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
repository
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Message for responding to get read token.
- Return type
google.cloud.devtools.cloudbuild_v2.types.FetchReadTokenResponse
- fetch_read_write_token(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchReadWriteTokenRequest, dict]] = None, *, repository: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.FetchReadWriteTokenResponse [source]¶
Fetches read/write token of a given repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_fetch_read_write_token(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.FetchReadWriteTokenRequest( repository="repository_value", ) # Make the request response = client.fetch_read_write_token(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.FetchReadWriteTokenRequest, dict]) – The request object. Message for fetching SCM read/write token.
repository (str) –
Required. The resource name of the repository in the format
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
repository
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Message for responding to get read/write token.
- Return type
google.cloud.devtools.cloudbuild_v2.types.FetchReadWriteTokenResponse
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- get_connection(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.GetConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.Connection [source]¶
Gets details of a single connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_get_connection(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.GetConnectionRequest( name="name_value", ) # Make the request response = client.get_connection(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.GetConnectionRequest, dict]) – The request object. Message for getting the details of a Connection.
name (str) –
Required. The name of the Connection to retrieve. Format:
projects/*/locations/*/connections/*
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.
- Return type
- get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Gets the IAM access control policy for a function.
Returns an empty policy if the function exists and does not have a policy set.
- Parameters
request (
GetIamPolicyRequest
) – The request object. Request message for GetIamPolicy method.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A
Policy
is a collection ofbindings
. Abinding
binds one or moremembers
to a singlerole
. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Arole
is a named list of permissions (defined by IAM or configured by users). Abinding
can optionally specify acondition
, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.JSON Example
{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] }
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
For a description of IAM and its features, see the IAM developer’s guide.
- Return type
Policy
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
Deprecated. Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.
The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
- Parameters
client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.Operation [source]¶
Gets the latest state of a long-running operation.
- Parameters
request (
GetOperationRequest
) – The request object. Request message for GetOperation method.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An
Operation
object.- Return type
Operation
- get_repository(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.GetRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.types.repositories.Repository [source]¶
Gets details of a single repository.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_get_repository(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.GetRepositoryRequest( name="name_value", ) # Make the request response = client.get_repository(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.GetRepositoryRequest, dict]) – The request object. Message for getting the details of a Repository.
name (str) –
Required. The name of the Repository to retrieve. Format:
projects/*/locations/*/connections/*/repositories/*
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A repository associated to a parent connection.
- Return type
- list_connections(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.ListConnectionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListConnectionsPager [source]¶
Lists Connections in a given project and location.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_list_connections(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.ListConnectionsRequest( parent="parent_value", ) # Make the request page_result = client.list_connections(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.ListConnectionsRequest, dict]) – The request object. Message for requesting list of Connections.
parent (str) –
Required. The parent, which owns this collection of Connections. Format:
projects/*/locations/*
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Message for response to listing Connections. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListConnectionsPager
- list_repositories(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.ListRepositoriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListRepositoriesPager [source]¶
Lists Repositories in a given connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_list_repositories(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.ListRepositoriesRequest( parent="parent_value", ) # Make the request page_result = client.list_repositories(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesRequest, dict]) – The request object. Message for requesting list of Repositories.
parent (str) –
Required. The parent, which owns this collection of Repositories. Format:
projects/*/locations/*/connections/*
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Message for response to listing Repositories. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListRepositoriesPager
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- static parse_connection_path(path: str) Dict[str, str] [source]¶
Parses a connection path into its component segments.
- static parse_repository_path(path: str) Dict[str, str] [source]¶
Parses a repository path into its component segments.
- static parse_secret_version_path(path: str) Dict[str, str] [source]¶
Parses a secret_version path into its component segments.
- static parse_service_path(path: str) Dict[str, str] [source]¶
Parses a service path into its component segments.
- static repository_path(project: str, location: str, connection: str, repository: str) str [source]¶
Returns a fully-qualified repository string.
- static secret_version_path(project: str, secret: str, version: str) str [source]¶
Returns a fully-qualified secret_version string.
- static service_path(project: str, location: str, namespace: str, service: str) str [source]¶
Returns a fully-qualified service string.
- set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Sets the IAM access control policy on the specified function.
Replaces any existing policy.
- Parameters
request (
SetIamPolicyRequest
) – The request object. Request message for SetIamPolicy method.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A
Policy
is a collection ofbindings
. Abinding
binds one or moremembers
to a singlerole
. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Arole
is a named list of permissions (defined by IAM or configured by users). Abinding
can optionally specify acondition
, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.JSON Example
{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] }
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
For a description of IAM and its features, see the IAM developer’s guide.
- Return type
Policy
- test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
- Tests the specified IAM permissions against the IAM access control
policy for a function.
If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
- Parameters
request (
TestIamPermissionsRequest
) – The request object. Request message for TestIamPermissions method.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response message for
TestIamPermissions
method.- Return type
TestIamPermissionsResponse
- property transport: google.cloud.devtools.cloudbuild_v2.services.repository_manager.transports.base.RepositoryManagerTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
RepositoryManagerTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
The universe domain used by the client instance.
- Return type
- update_connection(request: Optional[Union[google.cloud.devtools.cloudbuild_v2.types.repositories.UpdateConnectionRequest, dict]] = None, *, connection: Optional[google.cloud.devtools.cloudbuild_v2.types.repositories.Connection] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Updates a single connection.
# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud.devtools import cloudbuild_v2 def sample_update_connection(): # Create a client client = cloudbuild_v2.RepositoryManagerClient() # Initialize request argument(s) request = cloudbuild_v2.UpdateConnectionRequest( ) # Make the request operation = client.update_connection(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v2.types.UpdateConnectionRequest, dict]) – The request object. Message for updating a Connection.
connection (google.cloud.devtools.cloudbuild_v2.types.Connection) – Required. The Connection to update. This corresponds to the
connection
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) – The list of fields to be updated. This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.devtools.cloudbuild_v2.types.Connection
A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.
- The result type for the operation will be
- Return type
- class google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.FetchLinkableRepositoriesAsyncPager(method: Callable[[...], Awaitable[google.cloud.devtools.cloudbuild_v2.types.repositories.FetchLinkableRepositoriesResponse]], request: google.cloud.devtools.cloudbuild_v2.types.repositories.FetchLinkableRepositoriesRequest, response: google.cloud.devtools.cloudbuild_v2.types.repositories.FetchLinkableRepositoriesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
fetch_linkable_repositories
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesResponse
object, and provides an__aiter__
method to iterate through itsrepositories
field.If there are more pages, the
__aiter__
method will make additionalFetchLinkableRepositories
requests and continue to iterate through therepositories
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.FetchLinkableRepositoriesPager(method: Callable[[...], google.cloud.devtools.cloudbuild_v2.types.repositories.FetchLinkableRepositoriesResponse], request: google.cloud.devtools.cloudbuild_v2.types.repositories.FetchLinkableRepositoriesRequest, response: google.cloud.devtools.cloudbuild_v2.types.repositories.FetchLinkableRepositoriesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
fetch_linkable_repositories
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesResponse
object, and provides an__iter__
method to iterate through itsrepositories
field.If there are more pages, the
__iter__
method will make additionalFetchLinkableRepositories
requests and continue to iterate through therepositories
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v2.types.FetchLinkableRepositoriesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListConnectionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.devtools.cloudbuild_v2.types.repositories.ListConnectionsResponse]], request: google.cloud.devtools.cloudbuild_v2.types.repositories.ListConnectionsRequest, response: google.cloud.devtools.cloudbuild_v2.types.repositories.ListConnectionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_connections
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v2.types.ListConnectionsResponse
object, and provides an__aiter__
method to iterate through itsconnections
field.If there are more pages, the
__aiter__
method will make additionalListConnections
requests and continue to iterate through theconnections
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v2.types.ListConnectionsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v2.types.ListConnectionsRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v2.types.ListConnectionsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListConnectionsPager(method: Callable[[...], google.cloud.devtools.cloudbuild_v2.types.repositories.ListConnectionsResponse], request: google.cloud.devtools.cloudbuild_v2.types.repositories.ListConnectionsRequest, response: google.cloud.devtools.cloudbuild_v2.types.repositories.ListConnectionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_connections
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v2.types.ListConnectionsResponse
object, and provides an__iter__
method to iterate through itsconnections
field.If there are more pages, the
__iter__
method will make additionalListConnections
requests and continue to iterate through theconnections
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v2.types.ListConnectionsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v2.types.ListConnectionsRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v2.types.ListConnectionsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListRepositoriesAsyncPager(method: Callable[[...], Awaitable[google.cloud.devtools.cloudbuild_v2.types.repositories.ListRepositoriesResponse]], request: google.cloud.devtools.cloudbuild_v2.types.repositories.ListRepositoriesRequest, response: google.cloud.devtools.cloudbuild_v2.types.repositories.ListRepositoriesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_repositories
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesResponse
object, and provides an__aiter__
method to iterate through itsrepositories
field.If there are more pages, the
__aiter__
method will make additionalListRepositories
requests and continue to iterate through therepositories
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v2.services.repository_manager.pagers.ListRepositoriesPager(method: Callable[[...], google.cloud.devtools.cloudbuild_v2.types.repositories.ListRepositoriesResponse], request: google.cloud.devtools.cloudbuild_v2.types.repositories.ListRepositoriesRequest, response: google.cloud.devtools.cloudbuild_v2.types.repositories.ListRepositoriesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_repositories
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesResponse
object, and provides an__iter__
method to iterate through itsrepositories
field.If there are more pages, the
__iter__
method will make additionalListRepositories
requests and continue to iterate through therepositories
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v2.types.ListRepositoriesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.