github.com/TrueCloudLab/frostfs-api-go/v2@v2.0.0-20230228134343-196241c4e79a/session/grpc/types.go (about)

     1  package session
     2  
     3  import (
     4  	acl "github.com/TrueCloudLab/frostfs-api-go/v2/acl/grpc"
     5  	refs "github.com/TrueCloudLab/frostfs-api-go/v2/refs/grpc"
     6  	status "github.com/TrueCloudLab/frostfs-api-go/v2/status/grpc"
     7  )
     8  
     9  // SetKey sets key to the X-Header.
    10  func (m *XHeader) SetKey(v string) {
    11  	m.Key = v
    12  }
    13  
    14  // SetValue sets value of the X-Header.
    15  func (m *XHeader) SetValue(v string) {
    16  	m.Value = v
    17  }
    18  
    19  // SetExp sets epoch number of the token expiration.
    20  func (m *SessionToken_Body_TokenLifetime) SetExp(v uint64) {
    21  	m.Exp = v
    22  }
    23  
    24  // SetNbf sets starting epoch number of the token.
    25  func (m *SessionToken_Body_TokenLifetime) SetNbf(v uint64) {
    26  	m.Nbf = v
    27  }
    28  
    29  // SetIat sets the number of the epoch in which the token was issued.
    30  func (m *SessionToken_Body_TokenLifetime) SetIat(v uint64) {
    31  	m.Iat = v
    32  }
    33  
    34  // SetId sets identifier of the session token.
    35  func (m *SessionToken_Body) SetId(v []byte) {
    36  	m.Id = v
    37  }
    38  
    39  // SetOwnerId sets identifier of the session token owner.
    40  func (m *SessionToken_Body) SetOwnerId(v *refs.OwnerID) {
    41  	m.OwnerId = v
    42  }
    43  
    44  // SetLifetime sets lifetime of the session token.
    45  func (m *SessionToken_Body) SetLifetime(v *SessionToken_Body_TokenLifetime) {
    46  	m.Lifetime = v
    47  }
    48  
    49  // SetSessionKey sets public session key in a binary format.
    50  func (m *SessionToken_Body) SetSessionKey(v []byte) {
    51  	m.SessionKey = v
    52  }
    53  
    54  // SetObjectAddressContext sets object context of the session token.
    55  func (m *SessionToken_Body) SetObjectSessionContext(v *ObjectSessionContext) {
    56  	m.Context = &SessionToken_Body_Object{
    57  		Object: v,
    58  	}
    59  }
    60  
    61  // SetContainerSessionContext sets container context of the session token.
    62  func (m *SessionToken_Body) SetContainerSessionContext(v *ContainerSessionContext) {
    63  	m.Context = &SessionToken_Body_Container{
    64  		Container: v,
    65  	}
    66  }
    67  
    68  // SetTarget specifies objects involved in the object session.
    69  func (m *ObjectSessionContext) SetTarget(cnr *refs.ContainerID, objs []*refs.ObjectID) {
    70  	m.Target = &ObjectSessionContext_Target{
    71  		Container: cnr,
    72  		Objects:   objs,
    73  	}
    74  }
    75  
    76  // SetVerb sets type of request for which the token is issued.
    77  func (m *ObjectSessionContext) SetVerb(v ObjectSessionContext_Verb) {
    78  	m.Verb = v
    79  }
    80  
    81  // SetVerb sets type of request for which the token is issued.
    82  func (x *ContainerSessionContext) SetVerb(v ContainerSessionContext_Verb) {
    83  	x.Verb = v
    84  }
    85  
    86  // SetWildcard sets wildcard flag of the container session.
    87  func (x *ContainerSessionContext) SetWildcard(v bool) {
    88  	x.Wildcard = v
    89  }
    90  
    91  // SetContainerId sets identifier of the container related to the session.
    92  func (x *ContainerSessionContext) SetContainerId(v *refs.ContainerID) {
    93  	x.ContainerId = v
    94  }
    95  
    96  // SetBody sets session token body.
    97  func (m *SessionToken) SetBody(v *SessionToken_Body) {
    98  	m.Body = v
    99  }
   100  
   101  // SetSignature sets session token signature.
   102  func (m *SessionToken) SetSignature(v *refs.Signature) {
   103  	m.Signature = v
   104  }
   105  
   106  // SetVersion sets client protocol version.
   107  func (m *RequestMetaHeader) SetVersion(v *refs.Version) {
   108  	m.Version = v
   109  }
   110  
   111  // SetEpoch sets client local epoch.
   112  func (m *RequestMetaHeader) SetEpoch(v uint64) {
   113  	m.Epoch = v
   114  }
   115  
   116  // SetTtl sets request TTL.
   117  func (m *RequestMetaHeader) SetTtl(v uint32) {
   118  	m.Ttl = v
   119  }
   120  
   121  // SetXHeaders sets request X-Headers.
   122  func (m *RequestMetaHeader) SetXHeaders(v []*XHeader) {
   123  	m.XHeaders = v
   124  }
   125  
   126  // SetSessionToken sets session token of the request.
   127  func (m *RequestMetaHeader) SetSessionToken(v *SessionToken) {
   128  	m.SessionToken = v
   129  }
   130  
   131  // SetBearerToken sets bearer token of the request.
   132  func (m *RequestMetaHeader) SetBearerToken(v *acl.BearerToken) {
   133  	m.BearerToken = v
   134  }
   135  
   136  // SetOrigin sets origin request meta header.
   137  func (m *RequestMetaHeader) SetOrigin(v *RequestMetaHeader) {
   138  	m.Origin = v
   139  }
   140  
   141  // GetNetworkMagic returns NeoFS network magic.
   142  func (m *RequestMetaHeader) GetNetworkMagic() uint64 {
   143  	if m != nil {
   144  		return m.MagicNumber
   145  	}
   146  
   147  	return 0
   148  }
   149  
   150  // SetNetworkMagic sets NeoFS network magic.
   151  func (m *RequestMetaHeader) SetNetworkMagic(v uint64) {
   152  	m.MagicNumber = v
   153  }
   154  
   155  // SetVersion sets server protocol version.
   156  func (m *ResponseMetaHeader) SetVersion(v *refs.Version) {
   157  	m.Version = v
   158  }
   159  
   160  // SetEpoch sets server local epoch.
   161  func (m *ResponseMetaHeader) SetEpoch(v uint64) {
   162  	m.Epoch = v
   163  }
   164  
   165  // SetTtl sets response TTL.
   166  func (m *ResponseMetaHeader) SetTtl(v uint32) {
   167  	m.Ttl = v
   168  }
   169  
   170  // SetXHeaders sets response X-Headers.
   171  func (m *ResponseMetaHeader) SetXHeaders(v []*XHeader) {
   172  	m.XHeaders = v
   173  }
   174  
   175  // SetOrigin sets origin response meta header.
   176  func (m *ResponseMetaHeader) SetOrigin(v *ResponseMetaHeader) {
   177  	m.Origin = v
   178  }
   179  
   180  // SetStatus sets response status.
   181  func (m *ResponseMetaHeader) SetStatus(v *status.Status) {
   182  	m.Status = v
   183  }
   184  
   185  // SetBodySignature sets signature of the request body.
   186  func (m *RequestVerificationHeader) SetBodySignature(v *refs.Signature) {
   187  	m.BodySignature = v
   188  }
   189  
   190  // SetMetaSignature sets signature of the request meta.
   191  func (m *RequestVerificationHeader) SetMetaSignature(v *refs.Signature) {
   192  	m.MetaSignature = v
   193  }
   194  
   195  // SetOriginSignature sets signature of the origin verification header of the request.
   196  func (m *RequestVerificationHeader) SetOriginSignature(v *refs.Signature) {
   197  	m.OriginSignature = v
   198  }
   199  
   200  // SetOrigin sets origin verification header of the request.
   201  func (m *RequestVerificationHeader) SetOrigin(v *RequestVerificationHeader) {
   202  	m.Origin = v
   203  }
   204  
   205  // SetBodySignature sets signature of the response body.
   206  func (m *ResponseVerificationHeader) SetBodySignature(v *refs.Signature) {
   207  	m.BodySignature = v
   208  }
   209  
   210  // SetMetaSignature sets signature of the response meta.
   211  func (m *ResponseVerificationHeader) SetMetaSignature(v *refs.Signature) {
   212  	m.MetaSignature = v
   213  }
   214  
   215  // SetOriginSignature sets signature of the origin verification header of the response.
   216  func (m *ResponseVerificationHeader) SetOriginSignature(v *refs.Signature) {
   217  	m.OriginSignature = v
   218  }
   219  
   220  // SetOrigin sets origin verification header of the response.
   221  func (m *ResponseVerificationHeader) SetOrigin(v *ResponseVerificationHeader) {
   222  	m.Origin = v
   223  }
   224  
   225  // FromString parses ObjectSessionContext_Verb from a string representation,
   226  // It is a reverse action to String().
   227  //
   228  // Returns true if s was parsed successfully.
   229  func (x *ObjectSessionContext_Verb) FromString(s string) bool {
   230  	i, ok := ObjectSessionContext_Verb_value[s]
   231  	if ok {
   232  		*x = ObjectSessionContext_Verb(i)
   233  	}
   234  
   235  	return ok
   236  }
   237  
   238  // FromString parses ContainerSessionContext_Verb from a string representation,
   239  // It is a reverse action to String().
   240  //
   241  // Returns true if s was parsed successfully.
   242  func (x *ContainerSessionContext_Verb) FromString(s string) bool {
   243  	i, ok := ContainerSessionContext_Verb_value[s]
   244  	if ok {
   245  		*x = ContainerSessionContext_Verb(i)
   246  	}
   247  
   248  	return ok
   249  }