Spec-Zone.ru › AWS CLI v2

[ aws . codecommit ]

get-comments-for-compared-commit

Описание

Возвращает информацию о комментариях, оставленных к сравнению двух коммитов.

Примечание

Счетчики реакций могут включать числа от идентификаторов пользователей, которые были удалены после того, как реакция была произведена. Для подсчета реакций от активных идентификаторов используйте GetCommentReactions.

См. также: Документацию AWS API

get-comments-for-compared-commit является постраничной операцией. Для получения всего набора результатов могут быть отправлены несколько API-запросов. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос аргумент --query должен извлечь данные из результатов следующих выражений запроса: commentsForComparedCommitData

Синтаксис

  get-comments-for-compared-commit
--repository-name <value>
[--before-commit-id <value>]
--after-commit-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--repository-name (строка)

Имя репозитория, в котором вы хотите сравнить коммиты.

--before-commit-id (строка)

Для определения направленности сравнения — полный идентификатор коммита до сравнения.

--after-commit-id (строка)

Для определения направленности сравнения — полный идентификатор коммита после сравнения.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания точки начала постраничной обработки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выходных данных команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые необходимо вернуть в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, в выходных данных команды предоставляется NextToken. Для возобновления постраничной обработки предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки API-запроса. Если предоставлено без значения или значение input, выводит пример входного JSON, который можно использовать как аргумент для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для просмотра комментариев к коммиту

Этот пример демонстрирует, как просмотреть комментарии, оставленные к сравнению двух коммитов в репозитории с именем MyDemoRepo.

aws codecommit get-comments-for-compared-commit \
    --repository-name MyDemoRepo \
    --before-commit-ID 6e147360EXAMPLE \
    --after-commit-id 317f8570EXAMPLE

Вывод:

{
    "commentsForComparedCommitData": [
        {
            "afterBlobId": "1f330709EXAMPLE",
            "afterCommitId": "317f8570EXAMPLE",
            "beforeBlobId": "80906a4cEXAMPLE",
            "beforeCommitId": "6e147360EXAMPLE",
            "comments": [
                {
                    "authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
                    "clientRequestToken": "123Example",
                    "commentId": "ff30b348EXAMPLEb9aa670f",
                    "content": "Whoops - I meant to add this comment to the line, not the file, but I don't see how to delete it.",
                    "creationDate": 1508369768.142,
                    "deleted": false,
                    "CommentId": "123abc-EXAMPLE",
                    "lastModifiedDate": 1508369842.278,
                    "callerReactions": [],
                    "reactionCounts":
                    {
                        "SMILE" : 6,
                        "THUMBSUP" : 1
                    }
                },
                {
                    "authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
                    "clientRequestToken": "123Example",
                    "commentId": "553b509bEXAMPLE56198325",
                    "content": "Can you add a test case for this?",
                    "creationDate": 1508369612.240,
                    "deleted": false,
                    "commentId": "456def-EXAMPLE",
                    "lastModifiedDate": 1508369612.240,
                    "callerReactions": [],
                    "reactionCounts":
                    {
                        "THUMBSUP" : 2
                    }
                }
            ],
            "location": {
                "filePath": "cl_sample.js",
                "filePosition": 1232,
                "relativeFileVersion": "after"
            },
            "repositoryName": "MyDemoRepo"
        }
    ],
    "nextToken": "exampleToken"
}

Вывод

commentsForComparedCommitData -> (список)

Список объектов комментариев к сравниваемому коммиту.

(структура)

Возвращает информацию о комментариях к сравнению двух коммитов.

repositoryName -> (строка)

Имя репозитория, содержащего сравниваемые коммиты.

beforeCommitId -> (строка)

Полный идентификатор коммита, используемого для определения «до» сравнения.

afterCommitId -> (строка)

Полный идентификатор коммита, используемого для определения «после» сравнения.

beforeBlobId -> (строка)

Полный идентификатор блоба коммита, используемого для определения «до» сравнения.

afterBlobId -> (строка)

Полный идентификатор блоба коммита, используемого для определения «после» сравнения.

location -> (структура)

Информация о местоположении комментария в сравнении, включая имя файла, номер строки и то, относится ли версия файла, где был сделан комментарий, к «ДО» или «ПОСЛЕ».

filePath -> (строка)

Имя сравниваемого файла, включая расширение и подкаталог, если таковой имеется.

filePosition -> (целое)

Позиция изменения в сравниваемом файле в формате номера строки.

relativeFileVersion -> (строка)

В сравнении коммитов или запроса на вытягивание, относится ли изменение к «ДО» или «ПОСЛЕ» данного сравнения.

comments -> (список)

Массив объектов комментариев. Каждый объект комментария содержит информацию о комментарии к сравнению коммитов.

(структура)

Возвращает информацию о конкретном комментарии.

commentId -> (строка)

Сгенерированный системой идентификатор комментария.

content -> (строка)

Содержимое комментария.

inReplyTo -> (строка)

Идентификатор комментария, на который данное сообщение является ответом, если таковой имеется.

creationDate -> (метка времени)

Дата и время создания комментария в формате метки времени.

lastModifiedDate -> (метка времени)

Дата и время последнего изменения комментария в формате метки времени.

authorArn -> (строка)

Amazon Resource Name (ARN) пользователя, разместившего комментарий.

deleted -> (булево)

Булево значение, указывающее, был ли комментарий удален.

clientRequestToken -> (строка)

Уникальный, сгенерированный клиентом маркер идемпотентности, который при включении в запрос гарантирует, что запрос не может быть повторён с изменённым параметром. Если запрос получен с теми же параметрами и маркер включён, запрос возвращает информацию об исходном запросе, который использовал этот маркер.

callerReactions -> (список)

Эмодзи-реакции на комментарий, если таковые имеются, отправленные пользователем, чьи учетные данные связаны с вызовом API.

(строка)

reactionCounts -> (карта)

Карта «строка-целое число», представляющая количество отдельных пользователей, которые отреагировали на комментарий с указанными реакциями.

ключ -> (строка)

значение -> (целое число)

nextToken -> (строка)

Токен перечисления, который может быть использован в запросе для возврата следующей группы результатов.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API