パッケージ google.devtools.sourcerepo.v1

索引

SourceRepo

Source Repo API サービス。

CreateRepo

rpc CreateRepo(CreateRepoRequest) returns (Repo)

指定したプロジェクトに指定の名前でリポジトリを作成します。

指定した名前のレポジトリがすでに存在する場合、CreateRepo は ALREADY_EXISTS を返します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
DeleteRepo

rpc DeleteRepo(DeleteRepoRequest) returns (Empty)

リポジトリを削除します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

リソースのアクセス制御ポリシーを取得します。リソースが存在し、ポリシーが設定されていない場合は、空のポリシーを返します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
GetProjectConfig

rpc GetProjectConfig(GetProjectConfigRequest) returns (ProjectConfig)

プロジェクトの Cloud Source Repositories 構成を返します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
GetRepo

rpc GetRepo(GetRepoRequest) returns (Repo)

リポジトリに関する情報を返します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
ListRepos

rpc ListRepos(ListReposRequest) returns (ListReposResponse)

プロジェクトに属するすべてのリポジトリを返します。レポジトリのサイズは ListRepos で設定されません。レポジトリのサイズを取得するには、GetRepo を使用します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

指定したリソースにアクセス制御ポリシーを設定します。既存のポリシーをすべて置き換えます。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

指定したリソースに対して呼び出し元が持っている権限を返します。リソースが存在しない場合、NOT_FOUND エラーではなく、空の権限セットが返されます。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
UpdateProjectConfig

rpc UpdateProjectConfig(UpdateProjectConfigRequest) returns (ProjectConfig)

プロジェクトの Cloud Source Repositories 構成を更新します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。
UpdateRepo

rpc UpdateRepo(UpdateRepoRequest) returns (Repo)

リポジトリに関する情報を更新します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳しくは、Auth ガイドをご覧ください。

CreateRepoRequest

CreateRepo のリクエスト

フィールド
parent

string

レポジトリを作成するプロジェクト。値は projects/<project> の形式です。

承認には、指定されたリソースの parent に対する次の Google IAM 権限が必要です。

  • source.repos.create
repo

Repo

作成するレポジトリ。名前のみを設定します。他のフィールドを設定すると、エラーになります。名前のプロジェクトは、parent フィールドと一致させる必要があります。

DeleteRepoRequest

DeleteRepo のリクエスト

フィールド
name

string

削除するレポジトリの名前。値は projects/<project>/repos/<repo> の形式です。

承認には、指定されたリソースの name に対する次の Google IAM 権限が必要です。

  • source.repos.delete

GetProjectConfigRequest

GetProjectConfig のリクエスト。

フィールド
name

string

リクエスト対象のプロジェクトの名前。値は projects/<project> の形式です。

承認には、指定されたリソースの name に対する次の Google IAM 権限が必要です。

  • source.repos.getProjectConfig

GetRepoRequest

GetRepo のリクエスト

フィールド
name

string

リクエスト対象のリポジトリの名前。値は projects/<project>/repos/<repo> の形式です。

承認には、指定されたリソースの name に対する次の Google IAM 権限が必要です。

  • source.repos.get

ListReposRequest

ListRepos のリクエスト

フィールド
name

string

レポジトリを一覧表示するプロジェクトの ID。値は projects/<project> の形式です。

承認には、指定されたリソースの name に対する次の Google IAM 権限が必要です。

  • source.repos.list
page_size

int32

返されるレポジトリの最大数。1 から 500 までの値にします。設定されていない場合または 0 の場合には、サーバーでデフォルトの 100 が使用されます。

page_token

string

直前の ListReposResponse で中断されたところからレポジトリの一覧表示を再開します。これは、前の ListReposResponse の next_page_token フィールドから取得する不透明トークンです。

ListReposResponse

ListRepos のレスポンス。返されたレポジトリにサイズは設定されていません。

フィールド
repos[]

Repo

一覧表示されたレポジトリ。

next_page_token

string

空でない場合は、プロジェクト内に追加のレポジトリが存在します。この値を次の ListReposRequest の page_token フィールドに追加すると、これらのレポジトリの一覧表示を取得できます。

MirrorConfig

別のホスティング サービス（GitHub や Bitbucket など）からレポジトリを自動的にミラーリングする構成。

フィールド
url

string

他のホスティング サービスのメイン レポジトリの URL。

webhook_id

string

ミラーリングを開始する更新をリッスンする webhook の ID。この webhook を他のホスティング サービスから削除すると、Google Cloud Source Repositories で通知の受信が停止されるため、ミラーリングが無効になります。

deploy_key_id

string

他のホスティング サービスの SSH デプロイ鍵の ID。この鍵を他のサービスから削除すると、Google Cloud Source Repositories のミラーリング承認が解除されます。

ProjectConfig

プロジェクトの Cloud Source Repositories 構成。

フィールド
name

string

プロジェクトの名前。値は projects/<project> の形式です。

pubsub_configs

map<string, PubsubConfig>

このプロジェクトが Cloud Pub/Sub を通じてリポジトリの変更を公開する方法。トピック名をキーとします。

enable_private_key_check

bool

秘密鍵が含まれている Git push を拒否します。

PubsubConfig

Cloud Pub/Sub メッセージを公開するための構成。

フィールド
topic

string

Cloud Pub/Sub のトピック。値は projects/<project>/topics/<topic> の形式です。このプロジェクトは、この構成が入っているプロジェクトと同じである必要があります。

message_format

MessageFormat

Cloud Pub/Sub メッセージの形式。

service_account_email

string

Cloud Pub/Sub メッセージを公開するために使用するサービス アカウントのメールアドレス。このサービス アカウントは、PubsubConfig と同じプロジェクト内にある必要があります。追加する際、発信者はこのサービス アカウントに対して iam.serviceAccounts.actAs 権限を持っている必要があります。指定しない場合、デフォルトで Compute Engine デフォルト サービス アカウントに設定されます。

MessageFormat

Cloud Pub/Sub メッセージの形式。

列挙型
MESSAGE_FORMAT_UNSPECIFIED 未設定。
PROTOBUF メッセージ ペイロードは、SourceRepoEvent のシリアル化されたプロトコル バッファです。
JSON メッセージ ペイロードは、SourceRepoEvent の JSON 文字列です。

Repo

レポジトリ（Repo）は、バージョニングされたソース コンテンツを格納する Git レポジトリです。

フィールド
name

string

レポジトリのリソース名。projects/<project>/repos/<repo> の形式です。レポジトリ名にはスラッシュを使用できます。例: projects/myproject/repos/name/with/slash

size

int64

レポジトリのディスク使用量（バイト単位）。読み取り専用フィールドです。サイズは GetRepo によってのみ返されます。

url

string

Google Cloud Source Repositories からレポジトリのクローンを作成するための URL。読み取り専用フィールドです。

mirror_config

MirrorConfig

他のサービスによって管理されているレポジトリを、このレポジトリがミラーリングする方法。読み取り専用フィールドです。

pubsub_configs

map<string, PubsubConfig>

このリポジトリが Cloud Pub/Sub を通じてリポジトリの変更を公開する方法です。トピック名をキーとします。

UpdateProjectConfigRequest

UpdateProjectConfig のリクエスト。

フィールド
name

string

リクエスト対象のプロジェクトの名前。値は projects/<project> の形式です。

承認には、指定されたリソースの name に対する次の Google IAM 権限が必要です。

  • source.repos.updateProjectConfig
project_config

ProjectConfig

プロジェクトの新しい構成。

update_mask

FieldMask

変更する project_config のフィールドを指定する FieldMask。マスク内のフィールドのみが変更されます。マスクが指定されていない場合、このリクエストは処理されません。

UpdateRepoRequest

UpdateRepo のリクエスト。

フィールド
name

string

リクエスト対象のリポジトリの名前。値は projects/<project>/repos/<repo> の形式です。

承認には、指定されたリソースの name に対する次の Google IAM 権限が必要です。

  • source.repos.updateRepoConfig
repo

Repo

リポジトリの新しい構成。

update_mask

FieldMask

変更するリポジトリのフィールドを指定する FieldMask。マスク内のフィールドのみが変更されます。マスクが指定されていない場合、このリクエストは処理されません。