Class AwsCrossAccountRole (2.25.0)

public final class AwsCrossAccountRole extends GeneratedMessageV3 implements AwsCrossAccountRoleOrBuilder

Authentication method for Amazon Web Services (AWS) that uses Google owned AWS IAM user's access key to assume into customer's AWS IAM Role.

Protobuf type google.cloud.bigquery.connection.v1.AwsCrossAccountRole

Static Fields

EXTERNAL_ID_FIELD_NUMBER

public static final int EXTERNAL_ID_FIELD_NUMBER
Field Value
TypeDescription
int

IAM_ROLE_ID_FIELD_NUMBER

public static final int IAM_ROLE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

IAM_USER_ID_FIELD_NUMBER

public static final int IAM_USER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AwsCrossAccountRole getDefaultInstance()
Returns
TypeDescription
AwsCrossAccountRole

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AwsCrossAccountRole.Builder newBuilder()
Returns
TypeDescription
AwsCrossAccountRole.Builder

newBuilder(AwsCrossAccountRole prototype)

public static AwsCrossAccountRole.Builder newBuilder(AwsCrossAccountRole prototype)
Parameter
NameDescription
prototypeAwsCrossAccountRole
Returns
TypeDescription
AwsCrossAccountRole.Builder

parseDelimitedFrom(InputStream input)

public static AwsCrossAccountRole parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AwsCrossAccountRole parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AwsCrossAccountRole parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AwsCrossAccountRole parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AwsCrossAccountRole parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AwsCrossAccountRole parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AwsCrossAccountRole parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AwsCrossAccountRole parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AwsCrossAccountRole parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AwsCrossAccountRole parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AwsCrossAccountRole parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AwsCrossAccountRole parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsCrossAccountRole
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AwsCrossAccountRole> parser()
Returns
TypeDescription
Parser<AwsCrossAccountRole>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AwsCrossAccountRole getDefaultInstanceForType()
Returns
TypeDescription
AwsCrossAccountRole

getExternalId()

public String getExternalId()

Output only. A Google-generated id for representing Connection’s identity in AWS. External Id is also used for preventing the Confused Deputy Problem. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

string external_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The externalId.

getExternalIdBytes()

public ByteString getExternalIdBytes()

Output only. A Google-generated id for representing Connection’s identity in AWS. External Id is also used for preventing the Confused Deputy Problem. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

string external_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for externalId.

getIamRoleId()

public String getIamRoleId()

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

string iam_role_id = 1;

Returns
TypeDescription
String

The iamRoleId.

getIamRoleIdBytes()

public ByteString getIamRoleIdBytes()

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

string iam_role_id = 1;

Returns
TypeDescription
ByteString

The bytes for iamRoleId.

getIamUserId()

public String getIamUserId()

Output only. Google-owned AWS IAM User for a Connection.

string iam_user_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The iamUserId.

getIamUserIdBytes()

public ByteString getIamUserIdBytes()

Output only. Google-owned AWS IAM User for a Connection.

string iam_user_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for iamUserId.

getParserForType()

public Parser<AwsCrossAccountRole> getParserForType()
Returns
TypeDescription
Parser<AwsCrossAccountRole>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AwsCrossAccountRole.Builder newBuilderForType()
Returns
TypeDescription
AwsCrossAccountRole.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AwsCrossAccountRole.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AwsCrossAccountRole.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AwsCrossAccountRole.Builder toBuilder()
Returns
TypeDescription
AwsCrossAccountRole.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException