« blib/lib/Paws/CodeBuild/UpdateReportGroupOutput.pm
↑ Summary
blib/lib/Paws/CodeBuild/UpdateWebhookOutput.pm »
| 1 | |||
| 2 | package Paws::CodeBuild::UpdateWebhook; | ||
| 3 | use Moose; | ||
| 4 | has BranchFilter => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'branchFilter' ); | ||
| 5 | has BuildType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'buildType' ); | ||
| 6 | has FilterGroups => (is => 'ro', isa => 'ArrayRef[ArrayRef[Paws::CodeBuild::WebhookFilter]]', traits => ['NameInRequest'], request_name => 'filterGroups' ); | ||
| 7 | has ProjectName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'projectName' , required => 1); | ||
| 8 | has RotateSecret => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'rotateSecret' ); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateWebhook'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeBuild::UpdateWebhookOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CodeBuild::UpdateWebhook - Arguments for method UpdateWebhook on L<Paws::CodeBuild> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateWebhook on the | ||
| 26 | L<AWS CodeBuild|Paws::CodeBuild> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateWebhook. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateWebhook. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $codebuild = Paws->service('CodeBuild'); | ||
| 34 | my $UpdateWebhookOutput = $codebuild->UpdateWebhook( | ||
| 35 | ProjectName => 'MyProjectName', | ||
| 36 | BranchFilter => 'MyString', # OPTIONAL | ||
| 37 | BuildType => 'BUILD', # OPTIONAL | ||
| 38 | FilterGroups => [ | ||
| 39 | [ | ||
| 40 | { | ||
| 41 | Pattern => 'MyString', | ||
| 42 | Type => 'EVENT' | ||
| 43 | , # values: EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH, COMMIT_MESSAGE | ||
| 44 | ExcludeMatchedPattern => 1, # OPTIONAL | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | RotateSecret => 1, # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $Webhook = $UpdateWebhookOutput->Webhook; | ||
| 55 | |||
| 56 | # Returns a L<Paws::CodeBuild::UpdateWebhookOutput> object. | ||
| 57 | |||
| 58 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codebuild/UpdateWebhook> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 BranchFilter => Str | ||
| 65 | |||
| 66 | A regular expression used to determine which repository branches are | ||
| 67 | built when a webhook is triggered. If the name of a branch matches the | ||
| 68 | regular expression, then it is built. If C<branchFilter> is empty, then | ||
| 69 | all branches are built. | ||
| 70 | |||
| 71 | It is recommended that you use C<filterGroups> instead of | ||
| 72 | C<branchFilter>. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 BuildType => Str | ||
| 77 | |||
| 78 | Specifies the type of build this webhook will trigger. | ||
| 79 | |||
| 80 | Valid values are: C<"BUILD">, C<"BUILD_BATCH"> | ||
| 81 | |||
| 82 | =head2 FilterGroups => ArrayRef[L<ArrayRef[Paws::CodeBuild::WebhookFilter]>] | ||
| 83 | |||
| 84 | An array of arrays of C<WebhookFilter> objects used to determine if a | ||
| 85 | webhook event can trigger a build. A filter group must contain at least | ||
| 86 | one C<EVENT> C<WebhookFilter>. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> ProjectName => Str | ||
| 91 | |||
| 92 | The name of the CodeBuild project. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 RotateSecret => Bool | ||
| 97 | |||
| 98 | A boolean value that specifies whether the associated GitHub | ||
| 99 | repository's secret token should be updated. If you use Bitbucket for | ||
| 100 | your repository, C<rotateSecret> is ignored. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, documenting arguments for method UpdateWebhook in L<Paws::CodeBuild> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |