Get Trigger By Name Using GET

Get a gerrit trigger based on project and name

Request

URI

GET

http://cava-s-182-041.eng.vmware.com//codestream/api/gerrit-triggers/{project}/{name}

COPY

Path Parameters

string

name

Required

name

string

project

Required

project

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

'Success' with gerrit trigger

Returns GerritTrigger of type(s) */*

{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "branch": "master",
    "configurations": [
        {
            "pipeline": "rest_pipeline",
            "input": {},
            "eventType": "change-merged",
            "failureComment": "Pipeline Execution Failed",
            "successComment": "Pipeline Execution Successful"
        },
        {
            "pipeline": "rest_pipeline",
            "input": {},
            "eventType": "patchset-created",
            "verifiedLabel": "Verified",
            "failureComment": "Pipeline Failed",
            "successComment": "Pipeline Completed"
        }
    ],
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "description": "string",
    "enabled": true,
    "exclusions": [
        {
            "type": "PLAIN",
            "value": "example.txt"
        }
    ],
    "gerritProject": "TestGerritProject",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "inclusions": [
        {
            "type": "PLAIN",
            "value": "example.txt"
        }
    ],
    "listener": "Gerrit-Listener",
    "name": "My-Name",
    "prioritizeExclusion": true,
    "project": "My-Project",
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1"
}

integer As int64 As int64

_createTimeInMicros

Optional

This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds

string

_createdBy

Optional

This field is provided for backward compatibility. Contains the same value as the 'createdBy' field

string

_link

Optional

Partial URL that provides details of the resource.

integer As int64 As int64

_updateTimeInMicros

Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds

string

_updatedBy

Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field

string

branch

Optional

Gerrit Project Branch on which the change has to be monitored.

array of GerritTrigger_GerritEventConfiguration

configurations

Optional

The configuration of an Gerrit Event.

string

createdAt

Optional

Date when the entity was created. The date is in ISO 8601 with time zone

string

createdBy

Optional

The user that created this entity

string

description

Required

A human-friendly description.

boolean

enabled

Optional

Indicates that this trigger will be addressed on receiving respective events.

array of GerritTrigger_FileFilter

exclusions

Optional

Provide file exclusions as conditions for the trigger.

string

gerritProject

Optional

Gerrit Project which is to be monitored for the change.

string

Optional

The id of this resource.

array of GerritTrigger_FileFilter

inclusions

Optional

Provide file inclusions as conditions for the trigger.

string

listener

Optional

Gerrit Listener which will receive the events for this trigger.

string

name

Required

A human-friendly name used as an identifier in APIs that support this option

boolean

prioritizeExclusion

Optional

Prioritize Exclusion ensures that Pipelines are not triggered even if any of the files in a commit match the specified files in the exclusion paths or regex.

string

project

Optional

The project this entity belongs to.

string

updatedAt

Optional

Date when the entity was last updated. The date is in ISO 8601 with time zone.

string

updatedBy

Optional

The user that last updated this entity