C# Class ServiceClientGenerator.ServiceModel

The service model represents the information of a service found through the manifest, model, and customization file. It is used to get any information necessary to generate the clients, operations, and structures of a service.

Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method	Description
AvailableInWWW ( Operation operation ) : bool	returns if an operation is supported by the unity API or not.
Enumerations ( bool includeParentEnums ) : IEnumerable	Returns list of enums defined in the service model.
FindOperation ( string name ) : Operation	Gets the operation information based on the name of the operation
FindShape ( string name ) : Shape	Search the model for shape.
InitializeServiceModel ( TextReader reader ) : void	Sets the base json info no matter how the model was constructed
ServiceModel ( TextReader serviceModelReader, TextReader customizationReader ) : System	Used for unit testing, creates a service model from a TextReader so that the generation can be checked
ServiceModel ( string serviceModelPath, string customizationModelPath ) : System	Used by the generator to create a model for the service being generated
ToString ( ) : string	The service model represented as a string

Private Methods

Method	Description
CapitalizeFirstChar ( string text ) : string	Capitalizes the first character of a string, used to create proper naming for services, attributes, and operations

Method Details

AvailableInWWW() public method

returns if an operation is supported by the unity API or not.

public AvailableInWWW ( Operation operation ) : bool
operation	Operation
return	bool

Enumerations() public method

Returns list of enums defined in the service model.

public Enumerations ( bool includeParentEnums ) : IEnumerable
includeParentEnums	bool	Includes enums from current service model, which are also /// defined in the parent model.
return	IEnumerable

FindOperation() public method

Gets the operation information based on the name of the operation

public FindOperation ( string name ) : Operation
name	string	The name of the operation that information is needed for
return	Operation

FindShape() public method

Search the model for shape.

public FindShape ( string name ) : Shape
name	string	The name of the shape to search for
return	Shape

InitializeServiceModel() public method

Sets the base json info no matter how the model was constructed

public InitializeServiceModel ( TextReader reader ) : void
reader	TextReader	The reader to pull the model json from
return	void

ServiceModel() public method

Used for unit testing, creates a service model from a TextReader so that the generation can be checked

public ServiceModel ( TextReader serviceModelReader, TextReader customizationReader ) : System
serviceModelReader	TextReader	The reader to get the model information from
customizationReader	TextReader	The reader to get any customizations for the service from
return	System

ServiceModel() public method

Used by the generator to create a model for the service being generated

public ServiceModel ( string serviceModelPath, string customizationModelPath ) : System
serviceModelPath	string	Path to the file containing the model of the service
customizationModelPath	string	Path to the customizations file for the service
return	System

ToString() public method

The service model represented as a string

public ToString ( ) : string
return	string