C# Class ServiceClientGenerator.CustomizationsModel

A model used to represent different types of customizations for generating a service

Datei anzeigen Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method	Description
CreateNoArgOverload ( string operationName ) : bool	Determines if the operation has a customization for creating a no argument method
CustomizationsModel ( TextReader reader ) : Json.LitJson	Creates a customization model used to get customizations for a service
CustomizationsModel ( string modelPath ) : Json.LitJson	Creates a customization model used to get customizations for a service
EmitIsSetProperties ( string shapeName, string propertyName ) : bool	Determines if the collection property can be empty when being sent to the service.
GetDeprecationMessage ( string operationName ) : string
GetExamples ( string operationName ) : JsonData
GetOperationModifiers ( string operationName ) : OperationModifiers
GetOverrideShapeName ( string originalShapeName ) : string
GetPropertyModifier ( string shapeName, string propertyName ) : PropertyModifier	Gets the property modifier for a property in a shape (can be global) if so customized.
GetShapeModifier ( string shapeName ) : ShapeModifier
GetSubstituteShapeData ( string originalShapeName ) : JsonData	Returns the substitution entry for a shape
GetSubstituteShapeName ( string originalShapeName ) : string	Returns the name of the shape that should be used instead of the supplied shape
Initialize ( TextReader reader ) : void	Sets the document root by parsing the json text
IsExcludedProperty ( string propertyName, string shapeName = null ) : bool	Returns true if the specified property name is excluded at global or per-shape scope.
IsSubstitutedShape ( string originalShapeName ) : bool	Determines if the shape should be substituted with another
OverrideDataType ( string shapeName, string propertyName ) : DataTypeOverride	Gets any customizations for a new data type to be used on a property
UseNullable ( string shapeName, string propertyName ) : bool	Determines if the property has a customization to be set to nullable

Private Methods

Method	Description
GetRemappedShapeName ( string originalShapeName, string key ) : string
ParseExclusions ( ShapeModifier shapeModifier, JsonData data ) : void
ParseInjections ( ShapeModifier shapeModifier, JsonData data ) : void
ParseModifiers ( ShapeModifier shapeModifier, JsonData data ) : void

Method Details

CreateNoArgOverload() public method

Determines if the operation has a customization for creating a no argument method

public CreateNoArgOverload ( string operationName ) : bool
operationName	string	The name of the operation to check for
return	bool

CustomizationsModel() public method

Creates a customization model used to get customizations for a service

public CustomizationsModel ( TextReader reader ) : Json.LitJson
reader	TextReader	Reader to get the json text from
return	Json.LitJson

CustomizationsModel() public method

Creates a customization model used to get customizations for a service

public CustomizationsModel ( string modelPath ) : Json.LitJson
modelPath	string	Path to the file to read the customizations from
return	Json.LitJson

EmitIsSetProperties() public method

Determines if the collection property can be empty when being sent to the service.

public EmitIsSetProperties ( string shapeName, string propertyName ) : bool
shapeName	string	The name of the shape the property is in
propertyName	string	The name of the property
return	bool

GetDeprecationMessage() public method

public GetDeprecationMessage ( string operationName ) : string
operationName	string
return	string

GetExamples() public method

public GetExamples ( string operationName ) : JsonData
operationName	string
return	JsonData

GetOperationModifiers() public method

public GetOperationModifiers ( string operationName ) : OperationModifiers
operationName	string
return	OperationModifiers

GetOverrideShapeName() public method

public GetOverrideShapeName ( string originalShapeName ) : string
originalShapeName	string
return	string

GetPropertyModifier() public method

Gets the property modifier for a property in a shape (can be global) if so customized.

public GetPropertyModifier ( string shapeName, string propertyName ) : PropertyModifier
shapeName	string	The name of the shape containing the property
propertyName	string	The property name to look for
return	PropertyModifier

GetShapeModifier() public method

public GetShapeModifier ( string shapeName ) : ShapeModifier
shapeName	string
return	ShapeModifier

GetSubstituteShapeData() public method

Returns the substitution entry for a shape

public GetSubstituteShapeData ( string originalShapeName ) : JsonData
originalShapeName	string
return	JsonData

GetSubstituteShapeName() public method

Returns the name of the shape that should be used instead of the supplied shape

public GetSubstituteShapeName ( string originalShapeName ) : string
originalShapeName	string	The shape to have its name changed
return	string

Initialize() public method

Sets the document root by parsing the json text

public Initialize ( TextReader reader ) : void
reader	TextReader	The reader to get json text from
return	void

IsExcludedProperty() public method

Returns true if the specified property name is excluded at global or per-shape scope.

public IsExcludedProperty ( string propertyName, string shapeName = null ) : bool
propertyName	string
shapeName	string
return	bool

IsSubstitutedShape() public method

Determines if the shape should be substituted with another

public IsSubstitutedShape ( string originalShapeName ) : bool
originalShapeName	string	The original shape
return	bool

OverrideDataType() public method

Gets any customizations for a new data type to be used on a property

public OverrideDataType ( string shapeName, string propertyName ) : DataTypeOverride
shapeName	string	The name of the shape the property is defined within
propertyName	string	The name of the property to check
return	DataTypeOverride

UseNullable() public method

Determines if the property has a customization to be set to nullable

public UseNullable ( string shapeName, string propertyName ) : bool
shapeName	string	The name of the shape the property is in
propertyName	string	The name of the property
return	bool