Package com.google.cloudbuild.v1
Interface BuildTriggerOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
BuildTrigger,BuildTrigger.Builder
@Generated
public interface BuildTriggerOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanSubstitutions for Build resource.booleanAutodetect build configuration.getBuild()Contents of the build template.Contents of the build template.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Human-readable description of this trigger.com.google.protobuf.ByteStringHuman-readable description of this trigger.booleanIf true, the trigger will never automatically execute a build.Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml).com.google.protobuf.ByteStringPath, from the source root, to the build configuration file (i.e. cloudbuild.yaml).Optional.com.google.protobuf.ByteStringOptional.The file source describing the local or remote Build template.The file source describing the local or remote Build template.GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.getId()Output only.com.google.protobuf.ByteStringOutput only.getIgnoredFiles(int index) ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**".com.google.protobuf.ByteStringgetIgnoredFilesBytes(int index) ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**".intignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**".ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**".getIncludedFiles(int index) If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build.com.google.protobuf.ByteStringgetIncludedFilesBytes(int index) If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build.intIf any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build.If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build.getName()User-assigned name of the trigger.com.google.protobuf.ByteStringUser-assigned name of the trigger.PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.The configuration of a trigger that creates a build whenever an event from Repo API is received.The configuration of a trigger that creates a build whenever an event from Repo API is received.The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service.com.google.protobuf.ByteStringThe `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service.The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild.com.google.protobuf.ByteStringThe service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild.The repo and ref of the repository from which to build.The repo and ref of the repository from which to build.Deprecated.intSubstitutions for Build resource.Substitutions for Build resource.getSubstitutionsOrDefault(String key, String defaultValue) Substitutions for Build resource.Substitutions for Build resource.getTags(int index) Tags for annotation of a `BuildTrigger`com.google.protobuf.ByteStringgetTagsBytes(int index) Tags for annotation of a `BuildTrigger`intTags for annotation of a `BuildTrigger`Tags for annotation of a `BuildTrigger`Template describing the types of source changes to trigger a build.Template describing the types of source changes to trigger a build.WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.booleanAutodetect build configuration.booleanhasBuild()Contents of the build template.booleanOutput only.booleanPath, from the source root, to the build configuration file (i.e. cloudbuild.yaml).booleanThe file source describing the local or remote Build template.booleanGitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.booleanPubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.booleanThe configuration of a trigger that creates a build whenever an event from Repo API is received.booleanThe repo and ref of the repository from which to build.booleanTemplate describing the types of source changes to trigger a build.booleanWebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getResourceName
String getResourceName()The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service.string resource_name = 34;- Returns:
- The resourceName.
-
getResourceNameBytes
com.google.protobuf.ByteString getResourceNameBytes()The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service.string resource_name = 34;- Returns:
- The bytes for resourceName.
-
getId
String getId()Output only. Unique identifier of the trigger.
string id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The id.
-
getIdBytes
com.google.protobuf.ByteString getIdBytes()Output only. Unique identifier of the trigger.
string id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for id.
-
getDescription
String getDescription()Human-readable description of this trigger.
string description = 10;- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Human-readable description of this trigger.
string description = 10;- Returns:
- The bytes for description.
-
getName
String getName()User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character.
string name = 21;- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character.
string name = 21;- Returns:
- The bytes for name.
-
getTagsList
Tags for annotation of a `BuildTrigger`
repeated string tags = 19;- Returns:
- A list containing the tags.
-
getTagsCount
int getTagsCount()Tags for annotation of a `BuildTrigger`
repeated string tags = 19;- Returns:
- The count of tags.
-
getTags
Tags for annotation of a `BuildTrigger`
repeated string tags = 19;- Parameters:
index- The index of the element to return.- Returns:
- The tags at the given index.
-
getTagsBytes
com.google.protobuf.ByteString getTagsBytes(int index) Tags for annotation of a `BuildTrigger`
repeated string tags = 19;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the tags at the given index.
-
hasTriggerTemplate
boolean hasTriggerTemplate()Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`.
.google.devtools.cloudbuild.v1.RepoSource trigger_template = 7;- Returns:
- Whether the triggerTemplate field is set.
-
getTriggerTemplate
RepoSource getTriggerTemplate()Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`.
.google.devtools.cloudbuild.v1.RepoSource trigger_template = 7;- Returns:
- The triggerTemplate.
-
getTriggerTemplateOrBuilder
RepoSourceOrBuilder getTriggerTemplateOrBuilder()Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`.
.google.devtools.cloudbuild.v1.RepoSource trigger_template = 7; -
hasGithub
boolean hasGithub()GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`.
.google.devtools.cloudbuild.v1.GitHubEventsConfig github = 13;- Returns:
- Whether the github field is set.
-
getGithub
GitHubEventsConfig getGithub()GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`.
.google.devtools.cloudbuild.v1.GitHubEventsConfig github = 13;- Returns:
- The github.
-
getGithubOrBuilder
GitHubEventsConfigOrBuilder getGithubOrBuilder()GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`.
.google.devtools.cloudbuild.v1.GitHubEventsConfig github = 13; -
hasPubsubConfig
boolean hasPubsubConfig()PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
.google.devtools.cloudbuild.v1.PubsubConfig pubsub_config = 29;- Returns:
- Whether the pubsubConfig field is set.
-
getPubsubConfig
PubsubConfig getPubsubConfig()PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
.google.devtools.cloudbuild.v1.PubsubConfig pubsub_config = 29;- Returns:
- The pubsubConfig.
-
getPubsubConfigOrBuilder
PubsubConfigOrBuilder getPubsubConfigOrBuilder()PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
.google.devtools.cloudbuild.v1.PubsubConfig pubsub_config = 29; -
hasWebhookConfig
boolean hasWebhookConfig()WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.
.google.devtools.cloudbuild.v1.WebhookConfig webhook_config = 31;- Returns:
- Whether the webhookConfig field is set.
-
getWebhookConfig
WebhookConfig getWebhookConfig()WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.
.google.devtools.cloudbuild.v1.WebhookConfig webhook_config = 31;- Returns:
- The webhookConfig.
-
getWebhookConfigOrBuilder
WebhookConfigOrBuilder getWebhookConfigOrBuilder()WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.
.google.devtools.cloudbuild.v1.WebhookConfig webhook_config = 31; -
hasAutodetect
boolean hasAutodetect()Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile Currently only available for GitHub App Triggers.
bool autodetect = 18;- Returns:
- Whether the autodetect field is set.
-
getAutodetect
boolean getAutodetect()Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile Currently only available for GitHub App Triggers.
bool autodetect = 18;- Returns:
- The autodetect.
-
hasBuild
boolean hasBuild()Contents of the build template.
.google.devtools.cloudbuild.v1.Build build = 4;- Returns:
- Whether the build field is set.
-
getBuild
Build getBuild()Contents of the build template.
.google.devtools.cloudbuild.v1.Build build = 4;- Returns:
- The build.
-
getBuildOrBuilder
BuildOrBuilder getBuildOrBuilder()Contents of the build template.
.google.devtools.cloudbuild.v1.Build build = 4; -
hasFilename
boolean hasFilename()Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml).
string filename = 8;- Returns:
- Whether the filename field is set.
-
getFilename
String getFilename()Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml).
string filename = 8;- Returns:
- The filename.
-
getFilenameBytes
com.google.protobuf.ByteString getFilenameBytes()Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml).
string filename = 8;- Returns:
- The bytes for filename.
-
hasGitFileSource
boolean hasGitFileSource()The file source describing the local or remote Build template.
.google.devtools.cloudbuild.v1.GitFileSource git_file_source = 24;- Returns:
- Whether the gitFileSource field is set.
-
getGitFileSource
GitFileSource getGitFileSource()The file source describing the local or remote Build template.
.google.devtools.cloudbuild.v1.GitFileSource git_file_source = 24;- Returns:
- The gitFileSource.
-
getGitFileSourceOrBuilder
GitFileSourceOrBuilder getGitFileSourceOrBuilder()The file source describing the local or remote Build template.
.google.devtools.cloudbuild.v1.GitFileSource git_file_source = 24; -
hasCreateTime
boolean hasCreateTime()Output only. Time when the trigger was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. Time when the trigger was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time when the trigger was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getDisabled
boolean getDisabled()If true, the trigger will never automatically execute a build.
bool disabled = 9;- Returns:
- The disabled.
-
getSubstitutionsCount
int getSubstitutionsCount()Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`.
map<string, string> substitutions = 11; -
containsSubstitutions
Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`.
map<string, string> substitutions = 11; -
getSubstitutions
Deprecated.UsegetSubstitutionsMap()instead. -
getSubstitutionsMap
Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`.
map<string, string> substitutions = 11; -
getSubstitutionsOrDefault
Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`.
map<string, string> substitutions = 11; -
getSubstitutionsOrThrow
Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`.
map<string, string> substitutions = 11; -
getIgnoredFilesList
ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build.
repeated string ignored_files = 15;- Returns:
- A list containing the ignoredFiles.
-
getIgnoredFilesCount
int getIgnoredFilesCount()ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build.
repeated string ignored_files = 15;- Returns:
- The count of ignoredFiles.
-
getIgnoredFiles
ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build.
repeated string ignored_files = 15;- Parameters:
index- The index of the element to return.- Returns:
- The ignoredFiles at the given index.
-
getIgnoredFilesBytes
com.google.protobuf.ByteString getIgnoredFilesBytes(int index) ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build.
repeated string ignored_files = 15;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the ignoredFiles at the given index.
-
getIncludedFilesList
If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build.
repeated string included_files = 16;- Returns:
- A list containing the includedFiles.
-
getIncludedFilesCount
int getIncludedFilesCount()If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build.
repeated string included_files = 16;- Returns:
- The count of includedFiles.
-
getIncludedFiles
If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build.
repeated string included_files = 16;- Parameters:
index- The index of the element to return.- Returns:
- The includedFiles at the given index.
-
getIncludedFilesBytes
com.google.protobuf.ByteString getIncludedFilesBytes(int index) If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build.
repeated string included_files = 16;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the includedFiles at the given index.
-
getFilter
String getFilter()Optional. A Common Expression Language string.
string filter = 30 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The filter.
-
getFilterBytes
com.google.protobuf.ByteString getFilterBytes()Optional. A Common Expression Language string.
string filter = 30 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for filter.
-
hasSourceToBuild
boolean hasSourceToBuild()The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.
.google.devtools.cloudbuild.v1.GitRepoSource source_to_build = 26;- Returns:
- Whether the sourceToBuild field is set.
-
getSourceToBuild
GitRepoSource getSourceToBuild()The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.
.google.devtools.cloudbuild.v1.GitRepoSource source_to_build = 26;- Returns:
- The sourceToBuild.
-
getSourceToBuildOrBuilder
GitRepoSourceOrBuilder getSourceToBuildOrBuilder()The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.
.google.devtools.cloudbuild.v1.GitRepoSource source_to_build = 26; -
getServiceAccount
String getServiceAccount()The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account (`[PROJECT_NUM]@cloudbuild.gserviceaccount.com`) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`string service_account = 33 [(.google.api.resource_reference) = { ... }- Returns:
- The serviceAccount.
-
getServiceAccountBytes
com.google.protobuf.ByteString getServiceAccountBytes()The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account (`[PROJECT_NUM]@cloudbuild.gserviceaccount.com`) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`string service_account = 33 [(.google.api.resource_reference) = { ... }- Returns:
- The bytes for serviceAccount.
-
hasRepositoryEventConfig
boolean hasRepositoryEventConfig()The configuration of a trigger that creates a build whenever an event from Repo API is received.
.google.devtools.cloudbuild.v1.RepositoryEventConfig repository_event_config = 39;- Returns:
- Whether the repositoryEventConfig field is set.
-
getRepositoryEventConfig
RepositoryEventConfig getRepositoryEventConfig()The configuration of a trigger that creates a build whenever an event from Repo API is received.
.google.devtools.cloudbuild.v1.RepositoryEventConfig repository_event_config = 39;- Returns:
- The repositoryEventConfig.
-
getRepositoryEventConfigOrBuilder
RepositoryEventConfigOrBuilder getRepositoryEventConfigOrBuilder()The configuration of a trigger that creates a build whenever an event from Repo API is received.
.google.devtools.cloudbuild.v1.RepositoryEventConfig repository_event_config = 39; -
getBuildTemplateCase
BuildTrigger.BuildTemplateCase getBuildTemplateCase()
-