9456a4e922
Some checks failed
CI / Run lints and checks (push) Failing after 47s
CI / Run tests (push) Failing after 1s
CI / Run race tests (push) Failing after 5s
CI / Build CLI docs (push) Has been skipped
CI / Run buf actions (push) Failing after 5s
CodeQL / Analyze (go) (push) Failing after 3s
CodeQL / Analyze (javascript) (push) Failing after 2s
Docker Image Scanners / scanners (push) Failing after 3s
Format / format (push) Failing after 3s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Draft newsletter (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
98 lines
3.8 KiB
Plaintext
98 lines
3.8 KiB
Plaintext
{{#models}}{{#model}}# {{classname}}
|
|
|
|
{{^isEnum}}
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
{{#vendorExtensions.x-is-one-of-interface}}
|
|
**{{classname}}Interface** | **interface { {{#discriminator}}{{propertyGetter}}() {{propertyType}}{{/discriminator}} }** | An interface that can hold any of the proper implementing types |
|
|
{{/vendorExtensions.x-is-one-of-interface}}
|
|
{{^vendorExtensions.x-is-one-of-interface}}
|
|
{{#vars}}**{{name}}** | {{^required}}Pointer to {{/required}}{{#isContainer}}{{#isArray}}{{#items}}{{^isPrimitiveType}}{{^isFile}}[{{/isFile}}{{/isPrimitiveType}}**[]{{dataType}}**{{^isPrimitiveType}}{{^isFile}}]({{dataType}}.md){{/isFile}}{{/isPrimitiveType}}{{/items}}{{/isArray}}{{#isMap}}{{#items}}{{^isPrimitiveType}}{{^isFile}}[{{/isFile}}{{/isPrimitiveType}}**map[string]{{dataType}}**{{^isPrimitiveType}}{{^isFile}}]({{^baseType}}{{dataType}}{{/baseType}}{{baseType}}.md){{/isFile}}{{/isPrimitiveType}}{{/items}}{{/isMap}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}{{^isFile}}{{^isDateTime}}[{{/isDateTime}}{{/isFile}}{{/isPrimitiveType}}**{{dataType}}**{{^isPrimitiveType}}{{^isFile}}{{^isDateTime}}]({{^baseType}}{{dataType}}{{/baseType}}{{baseType}}.md){{/isDateTime}}{{/isFile}}{{/isPrimitiveType}}{{/isContainer}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
|
|
{{/vars}}
|
|
{{/vendorExtensions.x-is-one-of-interface}}
|
|
|
|
## Methods
|
|
|
|
{{^vendorExtensions.x-is-one-of-interface}}
|
|
### New{{classname}}
|
|
|
|
`func New{{classname}}({{#vars}}{{#required}}{{nameInCamelCase}} {{dataType}}, {{/required}}{{/vars}}) *{{classname}}`
|
|
|
|
New{{classname}} instantiates a new {{classname}} object
|
|
This constructor will assign default values to properties that have it defined,
|
|
and makes sure properties required by API are set, but the set of arguments
|
|
will change when the set of required properties is changed
|
|
|
|
### New{{classname}}WithDefaults
|
|
|
|
`func New{{classname}}WithDefaults() *{{classname}}`
|
|
|
|
New{{classname}}WithDefaults instantiates a new {{classname}} object
|
|
This constructor will only assign default values to properties that have it defined,
|
|
but it doesn't guarantee that properties required by API are set
|
|
|
|
{{#vars}}
|
|
### Get{{name}}
|
|
|
|
`func (o *{{classname}}) Get{{name}}() {{vendorExtensions.x-go-base-type}}`
|
|
|
|
Get{{name}} returns the {{name}} field if non-nil, zero value otherwise.
|
|
|
|
### Get{{name}}Ok
|
|
|
|
`func (o *{{classname}}) Get{{name}}Ok() (*{{vendorExtensions.x-go-base-type}}, bool)`
|
|
|
|
Get{{name}}Ok returns a tuple with the {{name}} field if it's non-nil, zero value otherwise
|
|
and a boolean to check if the value has been set.
|
|
|
|
### Set{{name}}
|
|
|
|
`func (o *{{classname}}) Set{{name}}(v {{vendorExtensions.x-go-base-type}})`
|
|
|
|
Set{{name}} sets {{name}} field to given value.
|
|
|
|
{{^required}}
|
|
### Has{{name}}
|
|
|
|
`func (o *{{classname}}) Has{{name}}() bool`
|
|
|
|
Has{{name}} returns a boolean if a field has been set.
|
|
{{/required}}
|
|
|
|
{{#isNullable}}
|
|
### Set{{name}}Nil
|
|
|
|
`func (o *{{classname}}) Set{{name}}Nil(b bool)`
|
|
|
|
Set{{name}}Nil sets the value for {{name}} to be an explicit nil
|
|
|
|
### Unset{{name}}
|
|
`func (o *{{classname}}) Unset{{name}}()`
|
|
|
|
Unset{{name}} ensures that no value is present for {{name}}, not even an explicit nil
|
|
{{/isNullable}}
|
|
{{/vars}}
|
|
{{#vendorExtensions.x-implements}}
|
|
|
|
### As{{{.}}}
|
|
|
|
`func (s *{{classname}}) As{{{.}}}() {{{.}}}`
|
|
|
|
Convenience method to wrap this instance of {{classname}} in {{{.}}}
|
|
{{/vendorExtensions.x-implements}}
|
|
{{/vendorExtensions.x-is-one-of-interface}}
|
|
{{/isEnum}}
|
|
{{#isEnum}}
|
|
## Enum
|
|
|
|
{{#allowableValues}}{{#enumVars}}
|
|
* `{{name}}` (value: `{{{value}}}`)
|
|
{{/enumVars}}{{/allowableValues}}
|
|
{{/isEnum}}
|
|
|
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
|
|
{{/model}}{{/models}}
|