Struct google_classroom1::CourseAlias [] [src]

pub struct CourseAlias {
    pub alias: Option<String>,
}

Alternative identifier for a course.

An alias uniquely identifies a course. It must be unique within one of the following scopes:

  • domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom.

  • project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

Fields

Alias string. The format of the string indicates the desired alias scoping.

  • d:<name> indicates a domain-scoped alias. Example: d:math_101
  • p:<name> indicates a project-scoped alias. Example: p:abc123

This field has a maximum length of 256 characters.

Trait Implementations

impl Default for CourseAlias
[src]

[src]

Returns the "default value" for a type. Read more

impl Clone for CourseAlias
[src]

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl Debug for CourseAlias
[src]

[src]

Formats the value using the given formatter.

impl RequestValue for CourseAlias
[src]

impl ResponseResult for CourseAlias
[src]