model_collection_metadata.go

/*
 * Copyright (C) 2020-2024 Arm Limited or its affiliates and Contributors. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

/*
Solar API

This API provides a RESTful interface to all the Solar services e.g. looking for boards, building projects, etc. - This API uses Hypermedia as the Engine of Application State (HATEOAS) to drive the discovery and provide   affordances. - Discovery is possible by following links from the well known root resource. While this specification lists   all supported endpoints, it is only recommended that these are hard coded into a client if code generation is   being used. Otherwise, it is recommended that the discovery mechanisms present in the resources (affordances)   are used exclusively. - Affordances are links which indicate whether an action is currently possible, this is significantly different from   whether the service supports an action in general. This specification defines what actions could be possible,   but only by checking the affordances returned by the API in the returned resources, can a client determine whether   this action is currently possible or available for the current user. For example:   - An operation to modify a resource could be defined in this specification, but the user may lack the appropriate     privileges. In that situation, the affordance link would not be present in the resource when read. Therefore,     the client can infer that it is not possible to edit this resource and present appropriate information to the     user.   - An operation to delete a resource could be defined and be possible in some circumstances. The specification     describes that the delete is supported and how to use it, but the affordance describes whether it is currently     possible. The logic in the API may dictate that if the resource was in use (perhaps it is a running job or used     by another resource), then it will not be possible to delete that resource as it would result in a conflicted     state. - It is strongly encouraged that affordances are used by all clients, even those using code generation. This has the   ability to both improve robustness and the user experience by decoupling the client and server. For example, if for   some reason the criteria for deleting a resource changes, the logic is only implemented in the server and there is   no need to update the logic in the client as it is driven by the affordances. - The format used for the resources is the Hypertext Application Language (HAL), which includes the definition   of links and embedded resources. 

API version: 1.1.1
Contact: support@arm.com
*/

// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.

package client

import (
	"encoding/json"
	"time"
	"bytes"
	"fmt"
)

// checks if the CollectionMetadata type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &CollectionMetadata{}

// CollectionMetadata Information present in each resource that supports listing. This information provides information about the collection resource itself.
type CollectionMetadata struct {
	// Creation Time: UTC date and time when the resource was created. If this is a system created resource, this will be a fixed time unaffected by user actions.
	Ctime time.Time `json:"ctime"`
	// Expiry Time: UTC date and time when the resource will be removed automatically by the system and become unavailable.
	Etime NullableTime `json:"etime,omitempty"`
	// Last Modification Time: UTC date and time when the resource was last updated. For a resource that cannot be modified, this will be the same as `ctime`.
	Mtime time.Time `json:"mtime"`
	// Collection metadata: Total number of items present in the collection.
	Total int32 `json:"total"`
}

type _CollectionMetadata CollectionMetadata

// NewCollectionMetadata instantiates a new CollectionMetadata 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
func NewCollectionMetadata(ctime time.Time, mtime time.Time, total int32) *CollectionMetadata {
	this := CollectionMetadata{}
	this.Ctime = ctime
	this.Mtime = mtime
	this.Total = total
	return &this
}

// NewCollectionMetadataWithDefaults instantiates a new CollectionMetadata 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
func NewCollectionMetadataWithDefaults() *CollectionMetadata {
	this := CollectionMetadata{}
	return &this
}

// GetCtime returns the Ctime field value
func (o *CollectionMetadata) GetCtime() time.Time {
	if o == nil {
		var ret time.Time
		return ret
	}

	return o.Ctime
}

// GetCtimeOk returns a tuple with the Ctime field value
// and a boolean to check if the value has been set.
func (o *CollectionMetadata) GetCtimeOk() (*time.Time, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Ctime, true
}

// SetCtime sets field value
func (o *CollectionMetadata) SetCtime(v time.Time) {
	o.Ctime = v
}

// GetEtime returns the Etime field value if set, zero value otherwise (both if not set or set to explicit null).
func (o *CollectionMetadata) GetEtime() time.Time {
	if o == nil || IsNil(o.Etime.Get()) {
		var ret time.Time
		return ret
	}
	return *o.Etime.Get()
}

// GetEtimeOk returns a tuple with the Etime field value if set, nil otherwise
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *CollectionMetadata) GetEtimeOk() (*time.Time, bool) {
	if o == nil {
		return nil, false
	}
	return o.Etime.Get(), o.Etime.IsSet()
}

// HasEtime returns a boolean if a field has been set.
func (o *CollectionMetadata) HasEtime() bool {
	if o != nil && o.Etime.IsSet() {
		return true
	}

	return false
}

// SetEtime gets a reference to the given NullableTime and assigns it to the Etime field.
func (o *CollectionMetadata) SetEtime(v time.Time) {
	o.Etime.Set(&v)
}
// SetEtimeNil sets the value for Etime to be an explicit nil
func (o *CollectionMetadata) SetEtimeNil() {
	o.Etime.Set(nil)
}

// UnsetEtime ensures that no value is present for Etime, not even an explicit nil
func (o *CollectionMetadata) UnsetEtime() {
	o.Etime.Unset()
}

// GetMtime returns the Mtime field value
func (o *CollectionMetadata) GetMtime() time.Time {
	if o == nil {
		var ret time.Time
		return ret
	}

	return o.Mtime
}

// GetMtimeOk returns a tuple with the Mtime field value
// and a boolean to check if the value has been set.
func (o *CollectionMetadata) GetMtimeOk() (*time.Time, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Mtime, true
}

// SetMtime sets field value
func (o *CollectionMetadata) SetMtime(v time.Time) {
	o.Mtime = v
}

// GetTotal returns the Total field value
func (o *CollectionMetadata) GetTotal() int32 {
	if o == nil {
		var ret int32
		return ret
	}

	return o.Total
}

// GetTotalOk returns a tuple with the Total field value
// and a boolean to check if the value has been set.
func (o *CollectionMetadata) GetTotalOk() (*int32, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Total, true
}

// SetTotal sets field value
func (o *CollectionMetadata) SetTotal(v int32) {
	o.Total = v
}

func (o CollectionMetadata) MarshalJSON() ([]byte, error) {
	toSerialize,err := o.ToMap()
	if err != nil {
		return []byte{}, err
	}
	return json.Marshal(toSerialize)
}

func (o CollectionMetadata) ToMap() (map[string]interface{}, error) {
	toSerialize := map[string]interface{}{}
	toSerialize["ctime"] = o.Ctime
	if o.Etime.IsSet() {
		toSerialize["etime"] = o.Etime.Get()
	}
	toSerialize["mtime"] = o.Mtime
	toSerialize["total"] = o.Total
	return toSerialize, nil
}

func (o *CollectionMetadata) UnmarshalJSON(data []byte) (err error) {
	// This validates that all required properties are included in the JSON object
	// by unmarshalling the object into a generic map with string keys and checking
	// that every required field exists as a key in the generic map.
	requiredProperties := []string{
		"ctime",
		"mtime",
		"total",
	}

	allProperties := make(map[string]interface{})

	err = json.Unmarshal(data, &allProperties)

	if err != nil {
		return err;
	}

	for _, requiredProperty := range(requiredProperties) {
		if _, exists := allProperties[requiredProperty]; !exists {
			return fmt.Errorf("no value given for required property %v", requiredProperty)
		}
	}

	varCollectionMetadata := _CollectionMetadata{}

	decoder := json.NewDecoder(bytes.NewReader(data))
	decoder.DisallowUnknownFields()
	err = decoder.Decode(&varCollectionMetadata)

	if err != nil {
		return err
	}

	*o = CollectionMetadata(varCollectionMetadata)

	return err
}

type NullableCollectionMetadata struct {
	value *CollectionMetadata
	isSet bool
}

func (v NullableCollectionMetadata) Get() *CollectionMetadata {
	return v.value
}

func (v *NullableCollectionMetadata) Set(val *CollectionMetadata) {
	v.value = val
	v.isSet = true
}

func (v NullableCollectionMetadata) IsSet() bool {
	return v.isSet
}

func (v *NullableCollectionMetadata) Unset() {
	v.value = nil
	v.isSet = false
}

func NewNullableCollectionMetadata(val *CollectionMetadata) *NullableCollectionMetadata {
	return &NullableCollectionMetadata{value: val, isSet: true}
}

func (v NullableCollectionMetadata) MarshalJSON() ([]byte, error) {
	return json.Marshal(v.value)
}

func (v *NullableCollectionMetadata) UnmarshalJSON(src []byte) error {
	v.isSet = true
	return json.Unmarshal(src, &v.value)
}