Proton / Client / get_service_sync_config

get_service_sync_config#

Proton.Client.get_service_sync_config(**kwargs)#

Get detailed information for the service sync configuration.

Request Syntax

response = client.get_service_sync_config(
    serviceName='string'
)

Parameters:

serviceName (string) –

[REQUIRED]

The name of the service that you want to get the service sync configuration for.

Return type:

dict

Returns:

Response Syntax

{
    'serviceSyncConfig': {
        'branch': 'string',
        'filePath': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'serviceName': 'string'
    }
}

Response Structure

(dict) –
- serviceSyncConfig (dict) –
  
  The detailed data of the requested service sync configuration.
  - branch (string) –
    
    The name of the code repository branch that holds the service code Proton will sync with.
  - filePath (string) –
    
    The file path to the service sync configuration file.
  - repositoryName (string) –
    
    The name of the code repository that holds the service code Proton will sync with.
  - repositoryProvider (string) –
    
    The name of the repository provider that holds the repository Proton will sync with.
  - serviceName (string) –
    
    The name of the service that the service instance is added to.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException