@sisyphus.js/google
Version:
Precompiled google common protos by sisyphus protobuf compiler
83 lines • 2.86 kB
TypeScript
/**
* Output generated from semantically comparing two versions of a service
* configuration.
*
* Includes detailed information about a field that have changed with
* applicable advice about potential consequences for the change, such as
* backwards-incompatibility.
*/
export interface ConfigChange {
/**
* Object hierarchy path to the change, with levels separated by a '.'
* character. For repeated fields, an applicable unique identifier field is
* used for the index (usually selector, name, or id). For maps, the term
* 'key' is used. If the field has no unique identifier, the numeric index
* is used.
* Examples:
* - visibility.rules[selector=="google.LibraryService.ListBooks"].restriction
* - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
* - logging.producer_destinations[0]
*/
element?: string;
/**
* Value of the changed object in the old Service configuration,
* in JSON format. This field will not be populated if ChangeType == ADDED.
*/
oldValue?: string;
/**
* Value of the changed object in the new Service configuration,
* in JSON format. This field will not be populated if ChangeType == REMOVED.
*/
newValue?: string;
/** The type for this change, either ADDED, REMOVED, or MODIFIED. */
changeType?: ChangeType | (keyof typeof ChangeType);
/**
* Collection of advice provided for this change, useful for determining the
* possible impact of this change.
*/
advices?: Advice[];
}
export declare namespace ConfigChange {
const name = "google.api.ConfigChange";
}
/**
* Generated advice about this change, used for providing more
* information about how a change will affect the existing service.
*/
export interface Advice {
/**
* Useful description for why this advice was applied and what actions should
* be taken to mitigate any implied risks.
*/
description?: string;
}
export declare namespace Advice {
const name = "google.api.Advice";
}
/**
* Classifies set of possible modifications to an object in the service
* configuration.
*/
export declare enum ChangeType {
/** No value was provided. */
CHANGE_TYPE_UNSPECIFIED = 0,
/**
* The changed object exists in the 'new' service configuration, but not
* in the 'old' service configuration.
*/
ADDED = 1,
/**
* The changed object exists in the 'old' service configuration, but not
* in the 'new' service configuration.
*/
REMOVED = 2,
/**
* The changed object exists in both service configurations, but its value
* is different.
*/
MODIFIED = 3
}
export declare namespace ChangeType {
const name = "google.api.ChangeType";
}
//# sourceMappingURL=config_change.d.ts.map